size

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

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

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

• TInput extends SizeInput
• TRequirement extends number
• TMessage extends ErrorMessage<SizeIssue<TInput, TRequirement>> | undefined

Параметры

• requirement TRequirement
• message TMessage

Пояснение

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

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

• Action SizeAction<TInput, TRequirement, TMessage>

Примеры

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

Схема для проверки размера blob

Схема для проверки blob размером 256 байт.

const BlobSchema = v.pipe(
  v.blob(),
  v.size(256, 'The blob must be 256 bytes in size.')
);

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

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

const SetSchema = v.pipe(
  v.set(number()),
  v.size(8, 'The set must contain 8 numbers.')
);

Связанные API

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

Схемы

any, array, custom, instance, string, tuple, unknown

Методы

pipe

Утилиты

isOfKind, isOfType