maxEntries

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

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

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

• TInput extends EntriesInput
• TRequirement extends number
• TMessage extends ErrorMessage<MaxEntriesIssue<TInput, TRequirement>> | undefined

Параметры

• requirement TRequirement
• message TMessage

Пояснение

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

Возвращает

• Action MaxEntriesAction<TInput, TRequirement, TMessage>

Примеры

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

Максимальное количество записей объекта

Схема для проверки объекта, содержащего не более 5 записей.

const MaxEntriesSchema = v.pipe(
  v.record(v.string(), v.number()),
  v.maxEntries(5, 'Object must not exceed 5 entries.')
);

Связанные API

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

Схемы

looseObject, object, objectWithRest, record, strictObject, variant

Методы

pipe

Утилиты

isOfKind, isOfType