Skip to main content

isArrayConstraint()

isArrayConstraint<T>(schema): schema is ArrayConstraint<T>

Type guard for ArrayConstraint. Checks that the schema is an array type and has constraint methods.

Type Parameters​

T: T extends GenericSchema​

Parameters​

schema: GenericSchema​

The schema to check

Returns: schema is ArrayConstraint<T>​

True if the schema is an ArrayConstraint with constraint methods

Since​

2.0.0

Example​

const schema = array(string()).minLength(1);
if (isArrayConstraint(schema)) {
  // schema is narrowed to ArrayConstraint
  schema.maxLength(10); // constraint methods available
}