parse

Parses an unknown input based on a schema.

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

Generics

• TSchema extends BaseSchema

Parameters

• schema TSchema
• input unknown
• config SchemaConfig | 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 Output<TSchema>

Example

The following example show how parse can be used.

try {
  const EmailSchema = string([email()]);
  const email = 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,
• 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