values

Создает действие проверки значений.

const Action = v.values<TInput, TRequirement, TMessage>(requirement, message);

Обобщения

• TInput extends ValueInput
• TRequirement extends readonly TInput[]
• TMessage extends ErrorMessage<ValuesIssue<TInput, TRequirement>> | undefined

Параметры

• requirement TRequirement
• message TMessage

Объяснение

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

Это действие не изменяет тип конвейера. Вместо этого используйте схему picklist, если требуется, чтобы тип соответствовал объединению заданных значений.

Возвращает

• Action ValuesAction<TInput, TRequirement, TMessage>

Примеры

В следующих примерах показано, как можно использовать values.

Схема числа

Схема для проверки числа на соответствие заданным значениям.

const NumberSchema = v.pipe(
  v.number(),
  v.values([5, 15, 20], 'The number must be one of the allowed numbers.')
);

Связанные API

Следующие API можно использовать вместе с values.

Схемы

any, bigint, boolean, custom, date, number, string, unknown

Методы

pipe

Вспомогательные функции

isOfKind, isOfType