maxSize

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

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

Обобщения

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

Параметры

• requirement TRequirement
• message TMessage

Пояснение

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

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

• Action MaxSizeAction<TInput, TRequirement, TMessage>

Примеры

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

Схема размера двоичного объекта

Схема для проверки двоичного объекта максимальным размером 10 МБ.

const BlobSchema = v.pipe(
  v.blob(),
  v.maxSize(10 * 1024 * 1024, 'The blob must not exceed 10 MB.')
);

Схема размера множества

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

const SetSchema = v.pipe(
  v.set(number()),
  v.maxSize(8, 'The set must not exceed 8 numbers.')
);

Связанные API

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

Схемы

any, blob, custom, file, instance, map, set, unknown

Методы

pipe

Вспомогательные функции

isOfKind, isOfType