vue-qs / createStandardSchemaV1
Function: createStandardSchemaV1()
createStandardSchemaV1<
Parsers,PartialOutput>(parsers,options?):StandardSchemaV1<MaybePartial<PartialOutput,inferParserType<Parsers>>>
Defined in: standard-schema.ts:61
Creates a Standard Schema validating search params state with the given parsers. Use it with libraries that accept Standard Schemas for search params.
Values are serialized with the parsers, then parsed back in strict mode: a value the parsers can't represent is reported as an issue.
Type Parameters
Parsers
Parsers extends Record<string, AnyParserBuilder>
PartialOutput
PartialOutput extends boolean = false
Parameters
parsers
Parsers
options?
CreateStandardSchemaV1Options<Parsers, PartialOutput> = {}
Returns
StandardSchemaV1<MaybePartial<PartialOutput, inferParserType<Parsers>>>
Example
ts
const schema = createStandardSchemaV1({ page: parseAsInteger.withDefault(1) })
schema['~standard'].validate({ page: 2 }) // { value: { page: 2 } }
schema['~standard'].validate({}) // { value: { page: 1 } }