Skip to Content
@jetio/schema-builder docs are live 🎉
API ReferenceArraySchemaBuilder

ArraySchemaBuilder

Provides the universal and metadata methods ($id, title, description, enum, const, anyOf, allOf, oneOf, not, if, errorMessage, extend, build, …) plus the array-specific constraints below. Per type locking, only this type’s constraints are accessible once the builder is locked to array.

MethodParametersReturnsDescription
.items(...schemas)BuilderSchema[] or ((b: SchemaBuilder) => SchemaBuilder)[]SchemaBuilderSchema for all items (or tuple for Draft 07)
.prefixItems(...schemas)BuilderSchema[] or ((b: SchemaBuilder) => SchemaBuilder)[]SchemaBuilderTuple validation (Draft 2020-12)
.additionalItems(schema)BuilderSchema or (b: SchemaBuilder) => SchemaBuilderSchemaBuilderSchema for items beyond tuple (Draft 07)
.unevaluatedItems(schema)BuilderSchema or (b: SchemaBuilder) => SchemaBuilderSchemaBuilderSchema for unevaluated items (Draft 2019-09+)
.contains(schema)BuilderSchema or (b: SchemaBuilder) => SchemaBuilderSchemaBuilderArray must contain a matching item
.minContains(n)number or $dataSchemaBuilderMinimum matching items
.maxContains(n)number or $dataSchemaBuilderMaximum matching items
.minItems(n)number or $dataSchemaBuilderMinimum array length
.maxItems(n)number or $dataSchemaBuilderMaximum array length
.uniqueItems(value)boolean or $dataSchemaBuilderRequire unique items
Last updated on