recordAsync | /src/index.ts | valibot@v0.19.0

Module

x/valibot/src/index.ts>recordAsync

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

fabian-hiller/valibot

Go to Latest

error methods schemas transformations utils validations

index.ts (default module)

IntersectionOptionsAsync

IntersectionSchema

IntersectionSchemaAsync

NativeEnumSchemaAsync

NonNullableSchemaAsync

NonNullish

NonNullishSchema

NonNullishSchemaAsync

NonOptional

NonOptionalSchema

NonOptionalSchemaAsync

any

map

nan

set

url

function recordAsync

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

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

Creates an async record schema.

recordAsync<TRecordValue extends BaseSchema | BaseSchemaAsync>(

value: TRecordValue,

error?: ErrorMessage,

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

): RecordSchemaAsync<StringSchema, TRecordValue>

Creates an async record schema.

recordAsync<TRecordKey extends RecordKeyAsync, TRecordValue extends BaseSchema | BaseSchemaAsync>(

key: TRecordKey,

value: TRecordValue,

pipe?: PipeAsync<RecordOutput<TRecordKey, TRecordValue>>,

): RecordSchemaAsync<TRecordKey, TRecordValue>

Creates an async record schema.

recordAsync<TRecordKey extends RecordKeyAsync, TRecordValue extends BaseSchema | BaseSchemaAsync>(

key: TRecordKey,

value: TRecordValue,

error?: ErrorMessage,

pipe?: PipeAsync<RecordOutput<TRecordKey, TRecordValue>>,

): RecordSchemaAsync<TRecordKey, TRecordValue>

Creates an async record schema.

Type Parameters

TRecordValue extends BaseSchema | BaseSchemaAsync

Parameters

value: TRecordValue

The value schema.

optional

pipe: PipeAsync<RecordOutput<StringSchema, TRecordValue>>

A validation and transformation pipe.

Returns

RecordSchemaAsync<StringSchema, TRecordValue>

An async record schema.

Creates an async record schema.

Type Parameters

TRecordValue extends BaseSchema | BaseSchemaAsync

Parameters

value: TRecordValue

The value schema.

optional

error: ErrorMessage

The error message.

optional

pipe: PipeAsync<RecordOutput<StringSchema, TRecordValue>>

A validation and transformation pipe.

Returns

RecordSchemaAsync<StringSchema, TRecordValue>

An async record schema.

Creates an async record schema.

Type Parameters

TRecordKey extends RecordKeyAsync

TRecordValue extends BaseSchema | BaseSchemaAsync

Parameters

key: TRecordKey

The key schema.

value: TRecordValue

The value schema.

optional

pipe: PipeAsync<RecordOutput<TRecordKey, TRecordValue>>

A validation and transformation pipe.

Returns

RecordSchemaAsync<TRecordKey, TRecordValue>

An async record schema.

Creates an async record schema.

Type Parameters

TRecordKey extends RecordKeyAsync

TRecordValue extends BaseSchema | BaseSchemaAsync

Parameters

key: TRecordKey

The key schema.

value: TRecordValue

The value schema.

optional

error: ErrorMessage

The error message.

optional

pipe: PipeAsync<RecordOutput<TRecordKey, TRecordValue>>

A validation and transformation pipe.

Returns

RecordSchemaAsync<TRecordKey, TRecordValue>

An async record schema.