unwrap

Unwraps the wrapped schema.

const Schema = unwrap<TSchema>(schema);

Generics

• TSchema extends OptionalSchema<any, any> | OptionalSchemaAsync<any, any> | NullableSchema<any, any> | NullableSchemaAsync<any, any> | NullishSchema<any, any> | NullishSchemaAsync<any, any> | NonOptionalSchema<any> | NonOptionalSchemaAsync<any> | NonNullableSchema<any> | NonNullableSchemaAsync<any> | NonNullishSchema<any> | NonNullishSchemaAsync<any>

Parameters

• schema TSchema

Returns

• Schema TSchema['wrapped']

Examples

The following examples show how unwrap can be used.

Unwrap string schema

Unwraps the wrapped string schema.

const OptionalStringSchema = optional(string());
const StringSchema = unwrap(OptionalStringSchema);

Related

The following APIs can be combined with unwrap.

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,
• fallback,
• keyof,
• merge,
• omit,
• parse,
• partial,
• pick,
• required,
• transform