getDefault

Returns the default value of the schema.

const value = getDefault<TSchema>(schema);

Generics

• TSchema extends SchemaWithMaybeDefault

Parameters

• schema TSchema

Returns

• value DefaultValue<TSchema>

Examples

The following examples show how getDefault can be used.

Optional string schema

Get the default value of an optional string schema.

const OptionalStringSchema = optional(string(), "I'm the default!");
const defaultValue = getDefault(OptionalStringSchema); // "I'm the default!"

Related

The following APIs can be combined with getDefault.

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