vue-qs / createSerializer
Function: createSerializer()
createSerializer<
Parsers>(parsers,options?):Serializer<Parsers>
Defined in: serializer.ts:62
Creates a type-safe function that renders state into a query string, e.g. to build links.
Type Parameters
Parsers
Parsers extends ParserMap
Parameters
parsers
Parsers
options?
CreateSerializerOptions<Parsers> = {}
Returns
Serializer<Parsers>
Example
ts
const serialize = createSerializer({ q: parseAsString, page: parseAsInteger.withDefault(1) })
serialize({ q: 'vue', page: 2 }) // '?q=vue&page=2'
serialize('/search?lang=en', { q: 'vue' }) // '/search?lang=en&q=vue'
serialize('/search?q=vue', null) // '/search' (clears known keys)