parse

Parses an unknown input based on a schema.

const output = v.parse<TSchema>(schema, input, config);

Generics

• TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>

Parameters

• schema TSchema
• input unknown
• config Config<InferIssue<TSchema>> | undefined

Explanation

parse will throw a ValiError if the input does not match the schema. Therefore you should use a try/catch block to catch errors. If the input matches the schema, it is valid and the output of the schema will be returned typed.

Returns

• output InferOutput<TSchema>

Example

The following example show how parse can be used.

try {
  const EmailSchema = v.pipe(v.string(), v.email());
  const email = v.parse(EmailSchema, 'jane@example.com');

  // Handle errors if one occurs
} catch (error) {
  console.log(error);
}

Related

The following APIs can be combined with parse.

Schemas

any, array, bigint, blob, boolean, custom, date, enum, exactOptional, file, function, instance, intersect, lazy, literal, looseObject, looseTuple, map, nan, never, nonNullable, nonNullish, nonOptional, null, nullable, nullish, number, object, objectWithRest, optional, picklist, promise, record, set, strictObject, strictTuple, string, symbol, tuple, tupleWithRest, undefined, undefinedable, union, unknown, variant, void

Methods

assert, config, fallback, flatten, keyof, message, omit, partial, pick, pipe, required, summarize, unwrap

Utils

getDotPath, isValiError, ValiError