Spec-Zone.ru › Valibot

everyItem

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

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

Обобщения

  • TInput extends ArrayInput
  • TMessage extends ErrorMessage<EveryItemIssue<TInput>> | undefined

Параметры

  • requirement ArrayRequirement<TInput>
  • message TMessage

Пояснение

С помощью everyItem можно произвольно проверять элементы массива и возвращать true, если они корректны, или false в противном случае. Если не все элементы соответствуют вашему requirement, можно использовать message, чтобы настроить сообщение об ошибке.

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

  • Action EveryItemAction<TInput, TMessage>

Примеры

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

Схема отсортированного массива

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

const SortedArraySchema = v.pipe(
  v.array(v.number()),
  v.everyItem(
    (item, index, array) => index === 0 || item >= array[index - 1],
    'The numbers must be sorted in ascending order.'
  )
);

Связанные API

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

Схемы

any, array, custom, instance, tuple, unknown

Методы

pipe

Утилиты

isOfKind, isOfType

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

Spec-Zone.ru

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