getExamples

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

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

const examples = v.getExamples<TSchema>(schema);

Обобщения

• TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>

Параметры

• schema TSchema

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

• examples InferExamples<TSchema>

Примеры

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

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

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

const examples = v.getExamples(StringSchema);

// ['foo', 'bar', 'baz']

Вложенная схема

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

const examples = v.getExamples(NestedSchema);

// ['foo', 'bar', 'baz', 'qux', 'quux']

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

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

Схемы

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

Методы

pipe

Действия

examples