Skip to main content

record()

record<KeySchema, ValueSchema>(keySchema, valueSchema, message?): RecordSchema<KeySchema, ValueSchema>

Record schema - validates an object with typed keys and values.

Type Parameters​

KeySchema: KeySchema extends GenericSchema​

ValueSchema: ValueSchema extends GenericSchema​

Parameters​

keySchema: KeySchema​

Schema to validate keys (must be Schema<string>).

valueSchema: ValueSchema​

Schema to validate values.

message?: string​

Custom error message.

Returns: RecordSchema<KeySchema, ValueSchema>​

Schema that validates an object with typed keys/values.

Since​

2.0.0