getDescription

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

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

const description = v.getDescription<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>> | DescriptionAction<unknown, string>)[]]> | SchemaWithPipeAsync<readonly [BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>, ...(PipeItem<any, unknown, BaseIssue<unknown>> | PipeItemAsync<any, unknown, BaseIssue<unknown>> | DescriptionAction<unknown, string>)[]]>

Параметры

• schema TSchema

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

• description string | undefined

Примеры

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

Получение описания схемы

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

const UsernameSchema = v.pipe(
  v.string(),
  v.regex(/^[a-z0-9_-]{4,16}$/iu),
  v.title('Username'),
  v.description(
    'A username must be between 4 and 16 characters long and can only contain letters, numbers, underscores and hyphens.'
  )
);

const description = v.getDescription(UsernameSchema);

Переопределение унаследованных описаний

Получите описание схемы Gmail с переопределенным описанием.

const EmailSchema = v.pipe(v.string(), v.email(), v.description('Email'));

const GmailSchema = v.pipe(
  EmailSchema,
  v.endsWith('@gmail.com'),
  v.description('Gmail')
);

const description = v.getDescription(GmailSchema); // 'Gmail'

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

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

Действия

description