описание

Создаёт действие метаданных описания.

const Action = v.description<TInput, TDescription>(description_);

Обобщённые типы

• TInput extends any
• TDescription extends string

Параметры

• description_ TDescription

Пояснение

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

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

• Action DescriptionAction<TInput, TDescription>

Примеры

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

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

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

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 можно использовать вместе с description.

Схемы

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

Методы

getDescription, pipe

Утилиты

isOfKind, isOfType