map | /src/index.ts | valibot@v0.5.0

Module

x/valibot/src/index.ts>map

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

fabian-hiller/valibot

Extremely Popular

Go to Latest

error methods schemas transformations utils validations

index.ts (default module)

NativeEnumSchemaAsync

NonNullableSchemaAsync

NonNullish

NonNullishSchema

NonNullishSchemaAsync

NonOptional

NonOptionalSchema

NonOptionalSchemaAsync

any

map

nan

set

url

function map

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

map<TMapKey extends BaseSchema, TMapValue extends BaseSchema>(

key: TMapKey,

value: TMapValue,

pipe?: Pipe<MapOutput<TMapKey, TMapValue>>,

): MapSchema<TMapKey, TMapValue>

Creates a map schema.

map<TMapKey extends BaseSchema, TMapValue extends BaseSchema>(

key: TMapKey,

value: TMapValue,

error?: string,

pipe?: Pipe<MapOutput<TMapKey, TMapValue>>,

): MapSchema<TMapKey, TMapValue>

Creates a map schema.

Type Parameters

TMapKey extends BaseSchema

TMapValue extends BaseSchema

Parameters

key: TMapKey

The key schema.

value: TMapValue

The value schema.

optional

pipe: Pipe<MapOutput<TMapKey, TMapValue>>

A validation and transformation pipe.

Returns

MapSchema<TMapKey, TMapValue>

A map schema.

Creates a map schema.

Type Parameters

TMapKey extends BaseSchema

TMapValue extends BaseSchema

Parameters

key: TMapKey

The key schema.

value: TMapValue

The value schema.

optional

error: string

The error message.

optional

pipe: Pipe<MapOutput<TMapKey, TMapValue>>

A validation and transformation pipe.

Returns

MapSchema<TMapKey, TMapValue>

A map schema.