Skip to main content

map()

map<KeySchema, ValueSchema>(keySchema, valueSchema, message?): MapConstraint<KeySchema, ValueSchema>

Map schema - validates a Map with typed keys and values.

Type Parameters​

KeySchema: KeySchema extends GenericSchema​

ValueSchema: ValueSchema extends GenericSchema​

Parameters​

keySchema: KeySchema​

Schema to validate keys.

valueSchema: ValueSchema​

Schema to validate values.

message?: string​

Custom error message.

Returns: MapConstraint<KeySchema, ValueSchema>​

Schema that validates a Map with typed keys/values and constraints.

Since​

2.0.0