Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/valibot/src/index.ts>getDefaultsAsync

The modular and type safe schema library for validating structural data 🤖
Go to Latest
function getDefaultsAsync
import { getDefaultsAsync } from "https://deno.land/x/valibot@v1.0.0-beta.4/src/index.ts";

Returns the default values of the schema.

Hint: The difference to getDefault is that for object and tuple schemas this function recursively returns the default values of the subschemas instead of undefined.

Type Parameters

TSchema extends
| BaseSchema<unknown, unknown, BaseIssue<unknown>>
| BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>
| ObjectWithRestSchemaAsync<ObjectEntriesAsync, BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>, ErrorMessage<ObjectWithRestIssue> | undefined>
| TupleWithRestSchema<TupleItems, BaseSchema<unknown, unknown, BaseIssue<unknown>>, ErrorMessage<TupleWithRestIssue> | undefined>
| TupleWithRestSchemaAsync<TupleItemsAsync, BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>, ErrorMessage<TupleWithRestIssue> | undefined>

Parameters

schema: TSchema

The schema to get them from.

Returns

The default values.