Spec-Zone.ru › Valibot

tupleWithRestAsync

Создаёт схему кортежа с rest-элементами.

const Schema = v.tupleWithRestAsync<TItems, TRest, TMessage>(
  items,
  rest,
  message
);

Дженерики

  • TItems extends TupleItemsAsync
  • TRest extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>
  • TMessage extends ErrorMessage<TupleWithRestIssue> | undefined

Параметры

  • items TItems
  • rest TRest
  • message TMessage

Объяснение

С помощью tupleWithRestAsync вы можете проверить тип данных входного значения и соответствие содержимого items и rest. Если входное значение не является массивом, можно использовать message для настройки сообщения об ошибке.

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

  • Schema TupleWithRestSchemaAsync<TItems, TRest, TMessage>

Примеры

Следующие примеры показывают, как можно использовать tupleWithRestAsync. Дополнительные примеры и пояснения см. в руководстве по массивам.

Схема кортежа с rest-элементами

Схема для валидации кортежа с универсальными rest-элементами.

import { isEmailPresent } from '~/api';

const TupleSchemaWithRest = v.tupleWithRestAsync(
  [
    v.number(),
    v.pipeAsync(
      v.string(),
      v.email(),
      v.checkAsync(isEmailPresent, 'The email is not in the database.')
    ),
  ],
  v.boolean()
);

Связанные ресурсы

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

Схемы

any, array, bigint, blob, boolean, custom, date, enum, exactOptional, file, function, instance, intersect, lazy, literal, looseObject, looseTuple, map, nan, never, nonNullable, nonNullish, nonOptional, null, nullable, nullish, number, object, objectWithRest, optional, picklist, promise, record, set, strictObject, strictTuple, string, symbol, tuple, undefined, undefinedable, union, unknown, variant, void

Методы

config, getDefault, getFallback

Действия

check, checkItems, brand, description, empty, everyItem, excludes, filterItems, findItem, flavor, guard, includes, length, mapItems, maxLength, metadata, minLength, nonEmpty, notLength, partialCheck, rawCheck, rawTransform, readonly, reduceItems, someItem, sortItems, title, transform

Утилиты

entriesFromList, isOfKind, isOfType

Асинхронные API

arrayAsync, checkAsync, customAsync, exactOptionalAsync, fallbackAsync, getDefaultsAsync, getFallbacksAsync, intersectAsync, lazyAsync, looseObjectAsync, looseTupleAsync, mapAsync, nonNullableAsync, nonNullishAsync, nonOptionalAsync, nullableAsync, nullishAsync, objectAsync, objectWithRestAsync, optionalAsync, parseAsync, parserAsync, partialCheckAsync, pipeAsync, rawCheckAsync, rawTransformAsync, recordAsync, safeParseAsync, safeParserAsync, setAsync, strictObjectAsync, strictTupleAsync, transformAsync, tupleAsync, unionAsync, variantAsync

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

Spec-Zone.ru

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