getMetadata

Возвращает метаданные схемы.

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

const metadata = v.getMetadata<TSchema>(schema);

Обобщения

• TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>> | SchemaWithPipe<readonly [BaseSchema<unknown, unknown, BaseIssue<unknown>>, ...(PipeItem<any, unknown, BaseIssue<unknown>> | MetadataAction<unknown, string>)[]]> | SchemaWithPipeAsync<readonly [BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>, ...(PipeItem<any, unknown, BaseIssue<unknown>> | PipeItemAsync<any, unknown, BaseIssue<unknown>> | MetadataAction<unknown, string>)[]]>

Параметры

• schema TSchema

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

• metadata InferMetadata<TSchema>

Примеры

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

Получение метаданных схемы

Получение метаданных схемы имени пользователя.

const UsernameSchema = v.pipe(
  v.string(),
  v.regex(/^[a-z0-9_-]{4,16}$/iu),
  v.title('Username'),
  v.metadata({
    length: { min: 4, max: 16 },
    chars: ['letters', 'numbers', 'underscores', 'hyphens'],
  })
);

const metadata = v.getMetadata(UsernameSchema);

Связанные материалы

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

Действия

metadata