map

Creates a map schema.

const Schema = v.map<TKey, TValue, TMessage>(key, value, message);

Generics

Parameters

  • key TKey
  • value TValue
  • message TMessage

Explanation

With map you can validate the data type of the input and whether the entries matches key and value. 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 = v.map(v.string(), v.string());

Object map schema

Schema to validate a map with object values.

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

The following APIs can be combined with map.

Schemas

Methods

Actions

Utils

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 Thanaen
  • GitHub profile picture of KATT
  • GitHub profile picture of osdiab
  • GitHub profile picture of ruiaraujo012
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of F0rce
  • GitHub profile picture of caegdeveloper
  • GitHub profile picture of seahindeniz