instanceAsync | /src/schemas/index.ts | valibot@v0.5.0

x/valibot/src/schemas/index.ts>instanceAsync

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

Extremely Popular

any array bigint blob boolean date enumType instance literal map nan nativeEnum never nonNullable nonNullish nonOptional nullType nullable nullish number object optional record recursive set special string symbol tuple undefinedType union unknown voidType

index.ts (default module)

NativeEnumSchemaAsync

NonNullableSchemaAsync

NonNullish

NonNullishSchema

NonNullishSchemaAsync

NonOptional

NonOptionalSchema

NonOptionalSchemaAsync

any

map

nan

set

function instanceAsync

import { instanceAsync } from "https://deno.land/x/valibot@v0.5.0/src/schemas/index.ts";

instanceAsync<TClass extends Class>(of: TClass, pipe?: PipeAsync<InstanceType<TClass>>): InstanceSchemaAsync<TClass>

Creates an async instance schema.

instanceAsync<TClass extends Class>(

of: TClass,

error?: string,

pipe?: PipeAsync<InstanceType<TClass>>,

): InstanceSchemaAsync<TClass>

Creates an async instance schema.

Type Parameters

TClass extends Class

Parameters

of: TClass

The class of the instance.

optional

pipe: PipeAsync<InstanceType<TClass>>

A validation and transformation pipe.

Returns

InstanceSchemaAsync<TClass>

An async instance schema.

Creates an async instance schema.

Type Parameters

TClass extends Class

Parameters

of: TClass

The class of the instance.

optional

error: string

The error message.

optional

pipe: PipeAsync<InstanceType<TClass>>

A validation and transformation pipe.

Returns

InstanceSchemaAsync<TClass>

An async instance schema.