optionalAsync | /src/schemas/optional/optionalAsync.ts | valibot@v0.19.0 | Deno

Skip to main content

Deno 2 is finally here 🎉️

x/valibot/src/schemas/optional/optionalAsync.ts>optionalAsync

The modular and type safe schema library for validating structural data 🤖

fabian-hiller/valibot

Menu

index.ts (default module)

OptionalSchemaAsync

optionalAsync.ts

OptionalSchemaAsync

function optionalAsync

import { optionalAsync } from "https://deno.land/x/valibot@v0.19.0/src/schemas/optional/optionalAsync.ts";

optionalAsync<TWrapped extends BaseSchema | BaseSchemaAsync, TDefault extends Input<TWrapped> | undefined | Promise<Input<TWrapped> | undefined> = undefined>(wrapped: TWrapped, default_?: TDefault | (() => TDefault)): OptionalSchemaAsync<TWrapped, TDefault>

Creates an async optional schema.

Type Parameters

TWrapped extends BaseSchema | BaseSchemaAsync

optional

TDefault extends Input<TWrapped> | undefined | Promise<Input<TWrapped> | undefined> = undefined

Parameters

wrapped: TWrapped

The wrapped schema.

optional

default_: TDefault | (() => TDefault)

The default value.

Returns

OptionalSchemaAsync<TWrapped, TDefault>

An async optional schema.