getTitle

Возвращает заголовок схемы.

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

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

Параметры

• schema TSchema

Возвращает

• title string | undefined

Примеры

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

Получение заголовка схемы

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

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 title = v.getTitle(UsernameSchema); // 'Username'

Переопределение унаследованных заголовков

Получение заголовка схемы Gmail с переопределённым заголовком.

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

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

const title = v.getTitle(GmailSchema); // 'Gmail'

Связанные элементы

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

Действия

title