strictTuple
Создает схему строгого кортежа.
const Schema = v.strictTuple<TItems, TMessage>(items, message);
Дженерики
TItemsextends TupleItemsTMessageextends ErrorMessage<StrictTupleIssue> | undefined
Параметры
itemsTItemsmessageTMessage
Объяснение
С помощью strictTuple вы можете валидировать тип входных данных и проверять, соответствует ли содержимое items. Если входные данные не являются массивом или содержат неизвестные элементы, вы можете использовать message для настройки сообщения об ошибке.
Отличие от
tupleзаключается в том, что эта схема возвращает проблему для неизвестных элементов. Она намеренно возвращает только одну проблему. В противном случае злоумышленники могли бы отправлять большие массивы, чтобы исчерпать ресурсы устройства. Если вам нужна проблема для каждого неизвестного элемента, используйте схемуtupleWithRestсneverдля аргументаrest.
Возвращаемое значение
SchemaStrictTupleSchema<TItems, TMessage>
Примеры
Следующие примеры показывают, как можно использовать strictTuple. Дополнительные примеры и объяснения приведены в руководстве по массивам.
Простая схема кортежа
Схема для валидации строгого кортежа с двумя элементами.
const SimpleTupleSchema = v.strictTuple([v.string(), v.number()]);
Связанные элементы
Следующие API можно комбинировать с strictTuple.
Схемы
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, string, symbol, tuple, 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
© Fabian Hiller
Licensed under the MIT License.
https://valibot.dev/api/strictTuple/