parseQueryStates @vuqs/core

Parses values from a query.

Usage

import { codecs, defineQuerySchema, parseQueryStates } from '@vuqs/core'

const schema = defineQuerySchema({ q: codecs.string, page: codecs.integer.withDefault(1) })

parseQueryStates(schema, { q: 'phone', page: '2' })
// { q: 'phone', page: 2 }

Type

function parseQueryStates<TSchema extends QueryStateSchema>(schema: TSchema, query: ParsedQuery): QueryStateValues<TSchema>

Parameters

• schema: TSchema
  • The normalized param definitions, keyed by logical name.
• query: ParsedQuery
  • The parsed query object.

Return value

• values: QueryStateValues<TSchema>
  • Explicit values present in the query. Absent or invalid params are omitted; state-level defaults are not resolved. Object transforms may resolve static child defaults during decoding.

Related guide

Building URLs.