metadata

Создаёт пользовательское действие с метаданными.

const Action = v.metadata<TInput, TMetadata>(metadata_);

Обобщения

• TInput extends any
• TMetadata extends Record<string, unknown>

Параметры

• metadata_ TMetadata

Пояснение

С помощью metadata можно добавлять пользовательские метаданные к схеме. Это может быть полезно при работе с инструментами ИИ или для документирования.

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

• Action MetadataAction<TInput, TMetadata>

Примеры

В следующих примерах показано, как можно использовать metadata.

Схема таблицы профилей

Схема для описания таблицы профилей.

const ProfileTableSchema = v.pipe(
  v.object({
    username: v.pipe(v.string(), v.nonEmpty()),
    email: v.pipe(v.string(), v.email()),
    avatar: v.pipe(v.string(), v.url()),
    description: v.pipe(v.string(), v.maxLength(500)),
  }),
  v.metadata({
    table: 'profiles',
    primaryKey: 'username',
    indexes: ['email'],
  })
);

Связанные API

Следующие API можно использовать вместе с metadata.

Схемы

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

Методы

getMetadata, pipe

Утилиты

isOfKind, isOfType