vue-qs / Parser
Type Alias: Parser<T, K>
Parser<
T,K> =object
Defined in: parsers.ts:21
Converts between URL query values and typed state.
Type Parameters
T
T
The state type
K
K extends ParserType = "single"
Whether the parser reads a single value or repeated keys
Properties
type
readonlytype:K
Defined in: parsers.ts:22
Methods
parse()
parse(
value):T|null
Defined in: parsers.ts:24
Converts a query value into state, returning null for invalid input
Parameters
value
ParserInput<K>
Returns
T | null
serialize()
serialize(
value):ParserOutput<K>
Defined in: parsers.ts:26
Converts state into a query value
Parameters
value
T
Returns
ParserOutput<K>
eq()
eq(
valueA,valueB):boolean
Defined in: parsers.ts:28
Compares two state values (used for clearOnDefault and change detection)
Parameters
valueA
T
valueB
T
Returns
boolean