fallback

Returns a fallback output value when validating the passed schema failed.

const Schema = fallback<TSchema, TFallback>(schema, fallback);

Generics

• TSchema extends BaseSchema
• TFallback extends Fallback

Parameters

• schema TSchema
• fallback TFallback

Explanation

fallback allows you to define a fallback value for the output that will be used if the validation of the input fails. This means that no issues will be returned when using fallback and the schema will always return an output.

If you only want to set a default value for null or undefined inputs, you should use optional, nullable or nullish instead.

Warning: The fallback value is not validated. Make sure that the fallback value matches your schema.

Returns

• Schema SchemaWithFallback<TSchema, TFallback>

Examples

The following examples show how fallback can be used.

Fallback string schema

Schema that will always return a string output.

const FallbackStringSchema = fallback(string(), "I'm the fallback!");

Fallback date schema

Schema that will always return a Date output.

By using a function as the fallback parameter, the schema will return a new Date instance each time the input does not match the schema.

const FallbackDateSchema = fallback(date(), () => new Date());

Related

The following APIs can be combined with fallback.

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