enum

Создает схему перечисления (enum).

const Schema = v.enum<TEnum, TMessage>(enum, message);

Дженерики

• TEnum extends Enum
• TMessage extends ErrorMessage<EnumIssue> | undefined

Параметры

• enum TEnum
• message TMessage

Объяснение

С помощью enum вы можете проверить, соответствует ли входное значение варианту перечисления. Если входные данные невалидны, вы можете использовать message для настройки сообщения об ошибке.

Возвращаемое значение

• Schema EnumSchema<TEnum, TMessage>

Примеры

Следующие примеры показывают, как можно использовать enum.

Перечисление Direction

Схема для валидации варианта перечисления направления.

enum Direction {
  Left,
  Right,
}

const DirectionSchema = v.enum(Direction, 'Invalid direction');

Связанные ресурсы

Следующие API могут сочетаться с enum.

Схемы

array, exactOptional, intersect, lazy, looseObject, looseTuple, map, nonNullable, nonNullish, nonOptional, nullable, nullish, object, objectWithRest, optional, record, set, strictObject, strictTuple, tuple, tupleWithRest, undefinedable, union

Методы

assert, config, fallback, getDefault, getDefaults, getFallback, getFallbacks, is, message, parse, parser, pipe, safeParse, safeParser

Действия

check, brand, description, flavor, guard, metadata, rawCheck, rawTransform, readonly, title, transform

Утилиты

entriesFromList, isOfKind, isOfType