objectAsync | /src/schemas/index.ts | valibot@v0.24.0

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

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

any array bigint blob boolean date enum instance intersect literal map nan never nonNullable nonNullish nonOptional null nullable nullish number object optional picklist record recursive set special string symbol tuple undefined union unknown variant void

index.ts (default module)

NonNullableSchemaAsync

NonNullish

NonNullishSchema

NonNullishSchemaAsync

NonOptional

NonOptionalSchema

NonOptionalSchemaAsync

discriminatedUnionAsync

any

map

nan

set

function objectAsync

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

objectAsync<TEntries extends ObjectEntriesAsync>(entries: TEntries, pipe?: PipeAsync<ObjectOutput<TEntries, undefined>>): ObjectSchemaAsync<TEntries>

Creates an async object schema.

objectAsync<TEntries extends ObjectEntriesAsync>(

entries: TEntries,

message?: ErrorMessage,

pipe?: PipeAsync<ObjectOutput<TEntries, undefined>>,

): ObjectSchemaAsync<TEntries>

Creates an async object schema.

objectAsync<TEntries extends ObjectEntriesAsync, TRest extends BaseSchema | BaseSchemaAsync | undefined>(

entries: TEntries,

rest: TRest,

pipe?: PipeAsync<ObjectOutput<TEntries, TRest>>,

): ObjectSchemaAsync<TEntries, TRest>

Creates an async object schema.

objectAsync<TEntries extends ObjectEntriesAsync, TRest extends BaseSchema | BaseSchemaAsync | undefined>(

entries: TEntries,

rest: TRest,

message?: ErrorMessage,

pipe?: PipeAsync<ObjectOutput<TEntries, TRest>>,

): ObjectSchemaAsync<TEntries, TRest>

Creates an async object schema.

Type Parameters

TEntries extends ObjectEntriesAsync

Parameters

entries: TEntries

The object entries.

optional

pipe: PipeAsync<ObjectOutput<TEntries, undefined>>

A validation and transformation pipe.

Returns

ObjectSchemaAsync<TEntries>

An async object schema.

Creates an async object schema.

Type Parameters

TEntries extends ObjectEntriesAsync

Parameters

entries: TEntries

The object entries.

optional

message: ErrorMessage

The error message.

optional

pipe: PipeAsync<ObjectOutput<TEntries, undefined>>

A validation and transformation pipe.

Returns

ObjectSchemaAsync<TEntries>

An async object schema.

Creates an async object schema.

Type Parameters

TEntries extends ObjectEntriesAsync

TRest extends BaseSchema | BaseSchemaAsync | undefined

Parameters

entries: TEntries

The object entries.

rest: TRest

The object rest.

optional

pipe: PipeAsync<ObjectOutput<TEntries, TRest>>

A validation and transformation pipe.

Returns

ObjectSchemaAsync<TEntries, TRest>

An async object schema.

Creates an async object schema.

Type Parameters

TEntries extends ObjectEntriesAsync

TRest extends BaseSchema | BaseSchemaAsync | undefined

Parameters

entries: TEntries

The object entries.

rest: TRest

The object rest.

optional

message: ErrorMessage

The error message.

optional

pipe: PipeAsync<ObjectOutput<TEntries, TRest>>

A validation and transformation pipe.

Returns

ObjectSchemaAsync<TEntries, TRest>

An async object schema.