coerce

Coerces the input of a schema to match the required type.

const Schema = coerce<TSchema>(schema, action);

Generics

• TSchema extends BaseSchema

Parameters

• schema TSchema
• action (input: unknown) => unknown

Explanation

coerce can be used to transform an input before it is validated. The function of the action argument is executed at the very beginning of the process, before any other validation is performed. It is therefore perfect for enforcing a specific data type using the built-in data type objects like Boolean, String, Number and Date.

To transform the input at the very end of the process, after all other validations have been performed, use the transform method.

Returns

• Schema TSchema

Examples

The following examples show how coerce can be used.

Coerce string input

Schema that coerces a string input.

const StringSchema = coerce(string(), String);

Coerce date input

Schema that coerces a date input.

const DateSchema = coerce(date(), (input) => new Date(input));

Related

The following APIs can be combined with coerce.

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,
• fallback,
• getDefault,
• getDefaults,
• getFallback,
• getFallbacks,
• is,
• keyof,
• merge,
• omit,
• parse,
• partial,
• pick,
• required,
• safeParse,
• transform,
• unwrap