map

Creates a map schema.

// Map schema with an optional pipe
const Schema = map<TKey, TValue>(key, value, pipe);

// Map schema with an optional message and pipe
const Schema = map<TKey, TValue>(key, value, message, pipe);

Generics

• TKey extends BaseSchema
• TValue extends BaseSchema

Parameters

• key TKey
• value TValue
• message ErrorMessage | undefined
• pipe Pipe<MapOutput<TKey, TValue>> | undefined

Explanation

With map you can validate the data type of the input and whether the entries matches key and value. With pipe you can transform and validate the further details of the map. If the input is not a map, you can use message to customize the error message.

Returns

• Schema MapSchema<TKey, TValue>

Examples

The following examples show how map can be used.

String map schema

Schema to validate a map with string values.

const StringMapSchema = map(string(), string());

Object map schema

Schema to validate a map with object values.

const ObjectMapSchema = map(string(), object({ key: string() }));

Related

The following APIs can be combined with map.

Schemas

• any,
• array,
• bigint,
• blob,
• boolean,
• date,
• enum_,
• instance,
• intersect,
• lazy,
• literal,
• nan,
• never,
• nonNullable,
• nonNullish,
• nonOptional,
• null_,
• nullable,
• nullish,
• number,
• object,
• optional,
• picklist,
• record,
• set,
• special,
• string,
• symbol,
• tuple,
• undefined_,
• union,
• unknown,
• variant,
• void_

Methods

• brand,
• coerce,
• fallback,
• getDefault,
• getDefaults,
• getFallback,
• getFallbacks,
• is,
• parse,
• safeParse,
• transform

Transformations

• toCustom

Validations

• custom,
• maxSize,
• minSize,
• notSize,
• size