getDefaults

Возвращает значения по умолчанию для схемы.

Отличие от getDefault заключается в том, что для схем объектов и кортежей эта функция рекурсивно возвращает значения по умолчанию для подсхем вместо undefined.

const values = v.getDefaults<TSchema>(schema);

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

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

Параметры

• schema TSchema

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

• values InferDefaults<TSchema>

Примеры

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

Значения по умолчанию для объекта

Получить значения по умолчанию для схемы объекта.

const ObjectSchema = v.object({
  key: v.optional(v.string(), "I'm the default!"),
});

const defaultValues = v.getDefaults(ObjectSchema); // { key: "I'm the default!" }

Значения по умолчанию для кортежа

Получить значения по умолчанию для схемы кортежа.

const TupleSchema = v.tuple([v.nullable(v.number(), 100)]);
const defaultValues = v.getDefaults(TupleSchema); // [100]

Связанные API

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

Схемы

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

Методы

assert, config, fallback, keyof, message, omit, partial, pick, pipe, required, unwrap