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

Parameters

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

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() }));

The following APIs can be combined with map.

Schemas

Methods

Transformations

Validations

Contributors

Thanks to all the contributors who helped make this page better!

  • GitHub profile picture of fabian-hiller

Partners

Thanks to our partners who support the project ideally and financially.

Sponsors

Thanks to our GitHub sponsors who support the project financially.

  • GitHub profile picture of dailydotdev
  • GitHub profile picture of ivan-mihalic
  • GitHub profile picture of KATT
  • GitHub profile picture of osdiab
  • GitHub profile picture of Thanaen
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of caegdeveloper