examples

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

const Action = v.examples<TInput, TExamples>(examples_);

Обобщения

• TInput extends any
• TExamples extends readonly TInput[]

Параметры

• examples_ TExamples

Пояснение

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

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

• Action ExamplesAction<TInput, TExamples>

Примеры

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

Строковая схема

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

const StringSchema = v.pipe(v.string(), v.examples(['foo', 'bar', 'baz']));

Числовая схема

Схема для проверки числа с примерами.

const NumberSchema = v.pipe(v.number(), v.examples([1, 2, 3]));

Связанные API

Следующие API можно комбинировать с examples.

Схемы

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

Методы

getExamples, pipe

Утилиты

isOfKind, isOfType