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

NumberSchemaBuilder

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

MethodParametersReturnsDescription
.minimum(n)number or $dataSchemaBuilderMinimum value (inclusive)
.maximum(n)number or $dataSchemaBuilderMaximum value (inclusive)
.exclusiveMinimum(n)number or $dataSchemaBuilderMinimum value (exclusive)
.exclusiveMaximum(n)number or $dataSchemaBuilderMaximum value (exclusive)
.multipleOf(n)number or $dataSchemaBuilderMust be a multiple of n
.positive()—SchemaBuilderShorthand for minimum(0)
.negative()—SchemaBuilderShorthand for maximum(0)
.range(min, max)number or $data, number or $dataSchemaBuilderShorthand for minimum + maximum
Last updated on