Skip to content

vue-qs v0.2.8


vue-qs / QueryStates

Type Alias: QueryStates<Parsers> ​

QueryStates<Parsers> = Values<Parsers> & object

Defined in: composables/use-query-states.ts:25

A reactive object bound to several URL query keys. Assign properties (or v-model them through toRefs) to update the URL.

Type Declaration ​

$set ​

readonly $set: (values, options?) => Promise<URLSearchParams>

Updates several keys in a single URL update. Keys set to null are removed; passing null removes every key.

Parameters ​

values ​

SetQueryStatesValue<Parsers>

options? ​

Options

Returns ​

Promise<URLSearchParams>

The search params once written to the URL

Type Parameters ​

Parsers ​

Parsers extends ParserMap

Released under the MIT License. Questions or ideas? Join the GitHub Discussions.