Aller au contenu principal

isMapConstraint()

isMapConstraint<K, V>(schema): schema is MapConstraint<K, V>

Type guard for MapConstraint. Checks that the schema is a map type and has constraint methods.


Type Parameters

K: K extends GenericSchema

V: V extends GenericSchema


Parameters

schema: GenericSchema

The schema to check


Returns: schema is MapConstraint<K, V>

True if the schema is a MapConstraint with constraint methods


Since

2.0.0


Example

const schema = map(string(), number()).minSize(1);
if (isMapConstraint(schema)) {
// schema is narrowed to MapConstraint
schema.maxSize(10); // constraint methods available
}