recordAsync | /src/schemas/record/index.ts | valibot@v0.30.0

function recordAsync

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

recordAsync<TValue extends BaseSchema | BaseSchemaAsync>(value: TValue, pipe?: PipeAsync<RecordOutput<StringSchema, TValue>>): RecordSchemaAsync<StringSchema, TValue>

Creates an async record schema.

recordAsync<TValue extends BaseSchema | BaseSchemaAsync>(

value: TValue,

message?: ErrorMessage,

pipe?: PipeAsync<RecordOutput<StringSchema, TValue>>,

): RecordSchemaAsync<StringSchema, TValue>

Creates an async record schema.

recordAsync<TKey extends RecordKeyAsync, TValue extends BaseSchema | BaseSchemaAsync>(

key: TKey,

value: TValue,

pipe?: PipeAsync<RecordOutput<TKey, TValue>>,

): RecordSchemaAsync<TKey, TValue>

Creates an async record schema.

recordAsync<TKey extends RecordKeyAsync, TValue extends BaseSchema | BaseSchemaAsync>(

key: TKey,

value: TValue,

message?: ErrorMessage,

pipe?: PipeAsync<RecordOutput<TKey, TValue>>,

): RecordSchemaAsync<TKey, TValue>

Creates an async record schema.

Type Parameters

TValue extends BaseSchema | BaseSchemaAsync

Parameters

value: TValue

The value schema.

optional

pipe: PipeAsync<RecordOutput<StringSchema, TValue>>

A validation and transformation pipe.

Returns

RecordSchemaAsync<StringSchema, TValue>

An async record schema.

Creates an async record schema.

Type Parameters

TValue extends BaseSchema | BaseSchemaAsync

Parameters

value: TValue

The value schema.

optional

message: ErrorMessage

The error message.

optional

pipe: PipeAsync<RecordOutput<StringSchema, TValue>>

A validation and transformation pipe.

Returns

RecordSchemaAsync<StringSchema, TValue>

An async record schema.

Creates an async record schema.

Type Parameters

TKey extends RecordKeyAsync

TValue extends BaseSchema | BaseSchemaAsync

Parameters

key: TKey

The key schema.

value: TValue

The value schema.

optional

pipe: PipeAsync<RecordOutput<TKey, TValue>>

A validation and transformation pipe.

Returns

RecordSchemaAsync<TKey, TValue>

An async record schema.

Creates an async record schema.

Type Parameters

TKey extends RecordKeyAsync

TValue extends BaseSchema | BaseSchemaAsync

Parameters

key: TKey

The key schema.

value: TValue

The value schema.

optional

message: ErrorMessage

The error message.

optional

pipe: PipeAsync<RecordOutput<TKey, TValue>>

A validation and transformation pipe.

Returns

RecordSchemaAsync<TKey, TValue>

An async record schema.