value

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

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

Обобщения

• TInput extends ValueInput
• TRequirement extends TInput
• TMessage extends ErrorMessage<ValueIssue<TInput, TRequirement>> | undefined

Параметры

• requirement TRequirement
• message TMessage

Пояснение

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

Это действие не меняет тип конвейера. Используйте схему literal, если хотите, чтобы тип соответствовал определенному значению.

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

• Action ValueAction<TInput, TRequirement, TMessage>

Примеры

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

Схема числа

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

const NumberSchema = v.pipe(
  v.number(),
  v.value(100, 'The number must be 100.')
);

Схема даты

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

const DateSchema = v.pipe(
  v.date(),
  v.value(new Date('2000-01-01'), 'The date must be the first day of 2000.')
);

Связанные API

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

Схемы

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

Методы

pipe

Утилиты

isOfKind, isOfType