object

Создаёт схему объекта.

const Schema = v.object<TEntries, TMessage>(entries, message);

Дженерики

• TEntries extends ObjectEntries
• TMessage extends ErrorMessage<ObjectIssue> | undefined

Параметры

• entries TEntries
• message TMessage

Объяснение

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

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

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

• Schema ObjectSchema<TEntries, TMessage>

Примеры

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

Простая схема объекта

Схема для валидации объекта с двумя ключами.

const SimpleObjectSchema = v.object({
  key1: v.string(),
  key2: v.number(),
});

Объединение нескольких объектов

Схема, объединяющая записи двух схем объектов.

const MergedObjectSchema = v.object({
  ...ObjectSchema1.entries,
  ...ObjectSchema2.entries,
});

Пометить ключи как необязательные

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

const PartialObjectSchema = v.partial(
  v.object({
    key1: v.string(),
    key2: v.number(),
  })
);

Объект с выбранными записями

Схема для валидации только выбранных записей объекта.

const PickObjectSchema = v.pick(
  v.object({
    key1: v.string(),
    key2: v.number(),
    key3: v.boolean(),
  }),
  ['key1', 'key3']
);

Связанные разделы

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

Схемы

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, objectWithRest, optional, picklist, promise, record, set, strictObject, strictTuple, string, symbol, tuple, tupleWithRest, undefined, undefinedable, union, unknown, variant, void

Методы

assert, config, fallback, forward, getDefault, getDefaults, getFallback, getFallbacks, is, keyof, message, omit, parse, parser, partial, pick, pipe, required, safeParse, safeParser

Действия

check, brand, description, entries, flavor, maxEntries, metadata, minEntries, notEntries, partialCheck, rawCheck, rawTransform, readonly, title, transform

Утилиты

entriesFromList, isOfKind, isOfType