Spec-Zone.ru › Valibot

gtValue

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

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

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

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

Параметры

  • requirement TRequirement
  • message TMessage

Пояснение

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

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

  • Action GtValueAction<TInput, TRequirement, TMessage>

Примеры

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

Схема для числа

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

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

Схема для даты

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

const DateSchema = v.pipe(
  v.date(),
  v.gtValue(
    new Date('2000-01-01'),
    'The date must be greater than 1st January 2000.'
  )
);

Связанные элементы

Следующие API можно комбинировать с gtValue.

Схемы

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

Методы

pipe

Утилиты

isOfKind, isOfType

© Fabian Hiller
Licensed under the MIT License.
https://valibot.dev/api/gtValue/

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API