enum_

Creates an enum schema.

const Schema = enum_<TEnum>(enum_, message);

Generics

• TEnum extends Enum

Parameters

• enum_ TEnum
• message ErrorMessage | undefined

Explanation

With enum_ you can validate that the input corresponds to an enum option. If the input is invalid, you can use message to customize the error message.

Returns

• Schema EnumSchema<TEnum>

Examples

The following examples show how enum_ can be used.

Direction enum

Schema to validate a direction enum option.

enum Direction {
  Left,
  Right,
}

const DirectionSchema = enum_(Direction, 'Invalid direction');

Related

The following APIs can be combined with enum_.

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