Spec-Zone.ru › Valibot

checkItems

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

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

Обобщения

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

Параметры

  • requirement ArrayRequirement<TInput>
  • message TMessage

Пояснение

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

Особенность checkItems заключается в том, что он автоматически передает каждую проблему соответствующему элементу.

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

  • Action CheckItemsAction<TInput, TMessage>

Примеры

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

Без повторяющихся элементов

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

const ArraySchema = v.pipe(
  v.array(v.string()),
  v.checkItems(
    (item, index, array) => array.indexOf(item) === index,
    'Duplicate items are not allowed.'
  )
);

Связанные API

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

Схемы

any, array, custom, instance, tuple, unknown

Методы

pipe

Утилиты

isOfKind, isOfType

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

Spec-Zone.ru

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