enum_

Creates an enum schema.

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

Generics

  • TEnum extends Enum

Parameters

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

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');

The following APIs can be combined with enum_.

Schemas

Methods

Contributors

Thanks to all the contributors who helped make this page better!

  • GitHub profile picture of fabian-hiller

Partners

Thanks to our partners who support the project ideally and financially.

Sponsors

Thanks to our GitHub sponsors who support the project financially.

  • GitHub profile picture of dailydotdev
  • GitHub profile picture of ivan-mihalic
  • GitHub profile picture of KATT
  • GitHub profile picture of osdiab
  • GitHub profile picture of Thanaen
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of caegdeveloper