maxValue

Создает действие валидации максимального значения.

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

Обобщенные типы

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

Параметры

• requirement TRequirement
• message TMessage

Объяснение

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

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

• Action MaxValueAction<TInput, TRequirement, TMessage>

Примеры

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

Схема числа

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

const NumberSchema = v.pipe(
  v.number(),
  v.maxValue(100, 'The number must not exceed 100.')
);

Схема даты

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

const DateSchema = v.pipe(
  v.date(),
  v.maxValue(new Date('1999-12-31'), 'The date must not exceed the year 1999.')
);

Связанные API

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

Схемы

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

Методы

pipe

Утилиты

isOfKind, isOfType