defineQuerySchema @vuqs/core

Names a reusable schema, normalized so its type stays stable across composables and typeof derivations.

Usage

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

export const filters = defineQuerySchema({
  q: codecs.string,
  status: queryParam('status', codecs.literal(['open', 'closed'] as const)),
})

Type

function defineQuerySchema<const TSchema extends QueryStateSchemaInput>(schema: TSchema): NormalizeQueryStateSchema<TSchema>

Parameters

• schema: TSchema
  • A map of logical name to a codec or a queryParam definition, the same input useQueryStates accepts.

Return value

• schema: NormalizeQueryStateSchema<TSchema>
  • The schema with codec-shorthand entries normalized to DefinedQueryParam. Pass it to useQueryStates or createSerializer, and derive value types with QueryStateValues<typeof schema>.

NormalizeQueryStateSchema

type NormalizeQueryStateSchema<TSchema extends QueryStateSchemaInput> = {
  [Key in keyof TSchema]: TSchema[Key] extends AnyDefinedQueryParam
    ? TSchema[Key]
    : TSchema[Key] extends Codec<infer TValue>
      ? TSchema[Key] extends { readonly defaultValue: TValue }
        ? DefinedQueryParam<TValue, TValue, TValue, true>
        : DefinedQueryParam<TValue, TValue, TValue, false>
      : never
}

Related guide

Defining params.