getDefaults

Returns the default values of the schema.

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

const values = getDefaults<TSchema>(schema);

Generics

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

Parameters

• schema TSchema

Returns

• values DefaultValues<TSchema>

Examples

The following examples show how getDefaults can be used.

Object defaults

Get the default values of an object schema.

const ObjectSchema = object({ key: optional(string(), "I'm the default!") });
const defaultValues = getDefaults(ObjectSchema); // { key: "I'm the default!" }

Tuple defaults

Get the default values of a tuple schema.

const TupleSchema = tuple([nullable(number(), 100)]);
const defaultValues = getDefaults(TupleSchema); // [100]

Related

The following APIs can be combined with getDefaults.

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