заголовок

Создает действие метаданных заголовка.

const Action = v.title<TInput, TTitle>(title_);

Обобщения

• TInput extends any
• TTitle extends string

Параметры

• title_ TTitle

Пояснение

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

Возвращает

• Action TitleAction<TInput, TTitle>

Примеры

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

Схема имени пользователя

Схема для проверки имени пользователя.

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.'
  )
);

Связанные API

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

Схемы

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

Методы

getTitle, pipe

Утилиты

isOfKind, isOfType