Skip to content

vue-qs v0.1.18


vue-qs / createVueRouterAdapter

Function: createVueRouterAdapter()

createVueRouterAdapter(vueRouter, options): QueryAdapter

Defined in: adapters/vue-router-adapter.ts:33

Creates a query adapter that integrates with Vue Router This adapter reads and writes query parameters through Vue Router's API

Parameters

vueRouter

Router

The Vue Router instance to integrate with

options

VueRouterAdapterOptions = {}

Configuration options for the adapter

Returns

QueryAdapter

QueryAdapter that works with Vue Router

Example

typescript
import { createRouter } from 'vue-router';
import { createVueRouterAdapter } from 'vue-qs';

const router = createRouter({ ... });
const routerAdapter = createVueRouterAdapter(router);

// Use with the plugin
app.use(createVueQsPlugin({ queryAdapter: routerAdapter }));

Released under the MIT License.