Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/valibot/src/schemas/map/map.ts>map

The modular and type safe schema library for validating structural data 🤖
Go to Latest
function map
import { map } from "https://deno.land/x/valibot@v0.24.0/src/schemas/map/map.ts";

Creates a map schema.

Type Parameters

TKey extends BaseSchema
TValue extends BaseSchema

Parameters

key: TKey

The key schema.

value: TValue

The value schema.

optional
pipe: Pipe<MapOutput<TKey, TValue>>

A validation and transformation pipe.

Returns

A map schema.

Creates a map schema.

Type Parameters

TKey extends BaseSchema
TValue extends BaseSchema

Parameters

key: TKey

The key schema.

value: TValue

The value schema.

optional
message: ErrorMessage

The error message.

optional
pipe: Pipe<MapOutput<TKey, TValue>>

A validation and transformation pipe.

Returns

A map schema.