tuple

Создает схему кортежа.

const Schema = v.tuple<TItems, TMessage>(items, message);

Дженерики

• TItems extends TupleItems
• TMessage extends ErrorMessage<TupleIssue> | undefined

Параметры

• items TItems
• message TMessage

Объяснение

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

Эта схема удаляет неизвестные элементы. Вывод будет содержать только те элементы, которые вы укажете. Чтобы включить неизвестные элементы, используйте looseTuple. Чтобы возвращать ошибку при наличии неизвестных элементов, используйте strictTuple. Чтобы включить и валидировать неизвестные элементы, используйте tupleWithRest.

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

• Schema TupleSchema<TItems, TMessage>

Примеры

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

Простая схема кортежа

Схема для валидации кортежа из двух элементов.

const SimpleTupleSchema = v.tuple([v.string(), v.number()]);

Связанное

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

Схемы

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, tupleWithRest, undefined, undefinedable, union, unknown, variant, void

Методы

assert, config, fallback, getDefault, getDefaults, getFallback, getFallbacks, is, message, parse, parser, pipe, safeParse, safeParser

Действия

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