optionalAsync | /src/schemas/optional/optionalAsync.ts | valibot@v0.28.1 | 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

Extremely Popular

Menu

index.ts (default module)

OptionalSchemaAsync

optionalAsync.ts

OptionalSchemaAsync

function optionalAsync

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

optionalAsync<TWrapped extends BaseSchema | BaseSchemaAsync>(wrapped: TWrapped): OptionalSchemaAsync<TWrapped>

Creates an async optional schema.

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

Creates an async optional schema.

Creates an async optional schema.

Type Parameters

TWrapped extends BaseSchema | BaseSchemaAsync

Parameters

wrapped: TWrapped

The wrapped schema.

Returns

OptionalSchemaAsync<TWrapped>

An async optional schema.

Creates an async optional schema.

Type Parameters

TWrapped extends BaseSchema | BaseSchemaAsync

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

Parameters

wrapped: TWrapped

The wrapped schema.

default_: TDefault

The default value.

Returns

OptionalSchemaAsync<TWrapped, TDefault>

An async optional schema.