Skip to content

vue-qs v0.2.8


vue-qs / createLoader

Function: createLoader() ​

createLoader<Parsers>(parsers, options?): Loader<Parsers>

Defined in: loader.ts:76

Creates a function that parses search params into typed state, outside of components: in Nuxt server routes, route middleware, useAsyncData, or any server code.

Type Parameters ​

Parsers ​

Parsers extends ParserMap

Parameters ​

parsers ​

Parsers

options? ​

CreateLoaderOptions<Parsers> = {}

Returns ​

Loader<Parsers>

Example ​

ts
const loadSearchParams = createLoader({
  q: parseAsString.withDefault(''),
  page: parseAsInteger.withDefault(1),
})

// Nuxt server route
export default defineEventHandler((event) => {
  const { q, page } = loadSearchParams(getQuery(event))
})

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