safeParse

Parses an unknown input based on a schema.

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

Generics

• TSchema extends BaseSchema

Parameters

• schema TSchema
• input unknown
• config SchemaConfig | undefined

Returns

• result SafeParseResult<TSchema>

Example

The following example show how safeParse can be used.

const EmailSchema = string([email()]);
const result = 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,
• date,
• enum_,
• instance,
• intersect,
• lazy,
• literal,
• map,
• nan,
• never,
• nonNullable,
• nonNullish,
• nonOptional,
• null_,
• nullable,
• nullish,
• number,
• object,
• optional,
• picklist,
• record,
• set,
• special,
• string,
• symbol,
• tuple,
• undefined_,
• union,
• unknown,
• variant,
• void_

Methods

• brand,
• coerce,
• fallback,
• keyof,
• merge,
• omit,
• partial,
• pick,
• required,
• transform,
• unwrap