never

Creates a never schema.

const Schema = never(message);

Parameters

• message ErrorMessage | undefined

Explanation

When validated, never always returns an issue. You can use message to customize the error message.

Returns

• Schema NeverSchema

Examples

The following examples show how never can be used.

Strict object schema

Schema to prevent any unknown object properties.

Otherwise, unknown object properties are simply ignored by default.

const StrictObjectSchema = object({ key: sting() }, never());

Strict tuple schema

Schema to prevent any unknown tuple items.

Otherwise, unknown tuple items are simply ignored by default.

const StrictTupleSchema = tuple([string(), number()], never());

Related

The following APIs can be combined with never.

Schemas

• array,
• intersect,
• lazy,
• map,
• nonNullable,
• nonNullish,
• nonOptional,
• nullable,
• nullish,
• object,
• optional,
• record,
• set,
• tuple,
• union

Methods

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