multipleOf

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

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

Обобщения

• TInput extends number | bigint
• TRequirement extends number | bigint
• TMessage extends ErrorMessage<MultipleOfIssue<TInput, TRequirement>> | undefined

Параметры

• requirement TRequirement
• message TMessage

Пояснение

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

Возвращает

• Action MultipleOfAction<TInput, TRequirement, TMessage>

Примеры

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

Схема для четного числа

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

const EvenNumberSchema = v.pipe(
  v.number(),
  v.multipleOf(2, 'The number must be even.')
);

Связанные API

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

Схемы

any, bigint, custom, number, unknown

Методы

pipe

Утилиты

isOfKind, isOfType