minValue

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

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

Обобщения

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

Параметры

• requirement TRequirement
• message TMessage

Пояснение

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

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

• Action MinValueAction<TInput, TRequirement, TMessage>

Примеры

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

Схема числа

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

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

Схема даты

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

const DateSchema = v.pipe(
  v.date(),
  v.minValue(new Date('2000-01-01'), 'The date must be after the year 1999.')
);

Связанные API

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

Схемы

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

Методы

pipe

Утилиты

isOfKind, isOfType