map

Создаёт схему map.

const Schema = v.map<TKey, TValue, TMessage>(key, value, message);

Дженерики

• TKey extends BaseSchema<unknown, unknown, BaseIssue<unknown>>
• TValue extends BaseSchema<unknown, unknown, BaseIssue<unknown>>
• TMessage extends ErrorMessage<MapIssue> | undefined

Параметры

• key TKey
• value TValue
• message TMessage

Объяснение

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

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

• Schema MapSchema<TKey, TValue, TMessage>

Примеры

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

Схема строкового map

Схема для валидации map со строковыми значениями.

const StringMapSchema = v.map(v.string(), v.string());

Схема объектного map

Схема для валидации map с объектными значениями.

const ObjectMapSchema = v.map(v.string(), v.object({ key: v.string() }));

Связанное

Следующие API могут быть объединены с map.

Схемы

any, array, bigint, blob, boolean, custom, date, enum, exactOptional, file, function, instance, intersect, lazy, literal, looseObject, looseTuple, nan, never, nonNullable, nonNullish, nonOptional, null, nullable, nullish, number, object, objectWithRest, optional, picklist, promise, record, set, strictObject, strictTuple, 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, brand, description, flavor, guard, maxSize, metadata, minSize, notSize, rawCheck, rawTransform, readonly, size, title, transform

Утилиты

entriesFromList, isOfKind, isOfType