getFallbacks

Returns the fallback values of the schema.

The difference to getFallback is that for objects and tuples without an explicit fallback value, this function recursively returns the fallback values of the subschemas instead of undefined.

const values = getFallbacks<TSchema>(schema);

Generics

• TSchema extends SchemaWithMaybeFallback<BaseSchema | ObjectSchema<ObjectEntries, any> | TupleSchema<TupleItems, any>>

Parameters

• schema TSchema

Returns

• values FallbackValues<TSchema>

Examples

The following examples show how getFallbacks can be used.

Object fallbacks

Get the fallback values of an object schema.

const ObjectSchema = object({ key: fallback(string(), "I'm the fallback!") });
const fallbackValues = getFallbacks(ObjectSchema); // { key: "I'm the fallback!" }

Tuple fallbacks

Get the fallback values of a tuple schema.

const TupleSchema = tuple([fallback(number(), 100)]);
const fallbackValues = getFallbacks(TupleSchema); // [100]

Related

The following APIs can be combined with getFallbacks.

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

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