nonOptional

Creates a non optional schema.

This schema function can be used to override the behavior of optional.

const Schema = nonOptional<TWrapped>(wrapped, message);

Generics

• TWrapped extends BaseSchema

Parameters

• wrapped TWrapped
• message ErrorMessage | undefined

Explanation

With nonOptional the validation of your schema will not pass undefined inputs. If the input is undefined, you can use message to customize the error message.

Returns

• Schema NonOptionalSchema<TWrapped>

Examples

The following examples show how nonOptional can be used.

Non optional string

Schema that does not accept null.

const NonOptionalStringSchema = nonOptional(optional(string()));

Unwrap non optional

Use unwrap to undo the effect of nonOptional.

const NonOptionalNumberSchema = nonOptional(optional(number()));
const OptionalNumberSchema = unwrap(NonOptionalNumberSchema);

Related

The following APIs can be combined with nonOptional.

Schemas

• any,
• array,
• bigint,
• blob,
• boolean,
• date,
• enum_,
• instance,
• intersect,
• lazy,
• literal,
• map,
• nan,
• never,
• nonNullable,
• nonNullish,
• null_,
• nullable,
• nullish,
• number,
• object,
• optional,
• picklist,
• record,
• set,
• special,
• string,
• symbol,
• tuple,
• undefined_,
• union,
• unknown,
• variant,
• void_

Methods

• brand,
• coerce,
• fallback,
• getDefault,
• getDefaults,
• getFallback,
• getFallbacks,
• is,
• parse,
• safeParse,
• transform,
• unwrap