safeParse

Parses an unknown input based on a schema.

const result = v.safeParse<TSchema>(schema, input, config);

Generics

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

Parameters

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

Returns

• result SafeParseResult<TSchema>

Example

The following example show how safeParse can be used.

const EmailSchema = v.pipe(v.string(), v.email());
const result = v.safeParse(EmailSchema, 'jane@example.com');

if (result.success) {
  const email = result.output;
} else {
  console.log(result.issues);
}

Related

The following APIs can be combined with safeParse.

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