Number Schema

Create a schema that matches a numerical value.

See at Any Schema for the inherited methods you may call like:

• title()
• detail()
• required()
• forbidden()
• default()
• stripEmpty()
• allow()
• deny()
• valid()
• invalid()
• raw()

1. Sanitize

1.1. unit(unit) / toUnit(unit)

This specifies the unit of the stored numerical value and also allows to give values in each compatible unit which will automatically recognized and converted.

• unit() defines the primary unit, all given number values are of this unit
• toUnit() will make (maybe second) conversion and works only together with unit()

const schema = new NumberSchema().unit('m').toUnit('cm')
// allows the value to be: '1.28 m', '0.00128 km' or 1.28 => 128
schema.unit().toUnit() // to remove the setting

Both may be also given as reference:

const ref = new Reference('cm')
const schema = new NumberSchema().unit(ref)

1.2. sanitize(bool)

If this flag is set the first numerical value from the given text will be used. That allows any non numerical characters before or after the value, which will be stripped away.

const schema = new NumberSchema().sanitize()
schema.sanitize(false) // to remove the setting

You may use a reference here:

const ref = new Reference(true)
const schema = new NumberSchema().sanitize(ref)

The reference can point to any value which may be converted to true/false.

1.3. round(precision, method)

This allows to round the value to a given precision (number of fraction digits) and a rounding method ('arithmetic', 'floor', 'ceil'). The default is to use 0 digits arithmetic rounding if called without any parameter.

const schema = new NumberSchema().round(2)
schema.round(false) // to remove the setting

References are not allowed here but within integer.

1.4. integer(bool)

The integer flag will check for an integer value. If the sanitize flag is also used it will automatically round.

const schema = new NumberSchema().sanitize().integer()
schema.integer(false) // to remove the setting

You may use a reference here:

const ref = new Reference(true)
const schema = new NumberSchema().sanitize().integer(ref)

The reference can point to any value which may be converted to true/false.

2. Value checks

2.1. positive(bool) / negative(bool)

Allow only positive or negative values.

const schema = new NumberSchema().positive()

The corresponding other setting will be removed.

Both allow references, too:

const ref = new Reference(true)
const schema = new NumberSchema().negative(ref)

The reference can point to any value which may be converted to true/false.

2.2. min(value) / max(value) / greater(value) / less(value)

Define a allowed range of min, max or greater, less settings. The given value has to be within the defined range which also is involved with positive and negative. While min and max also include the given limit as value greater and less will not.

const schema = new NumberSchema().min(5).less(100)

In all of these settings references are allowed:

const ref = new Reference(15)
const schema = new NumberSchema().min(ref)

The reference should point to a numerical value.

2.3. integerType(type)

This allows to specify a integer bit size by giving one of the following names or bit-sizes:

Use positive to make it unsigned.

const schema = new NumberSchema().integerType('byte').positive()

References are not possible here.

2.4. multiple(value)

The data has to be a multiple of the value set here.

const schema = new NumberSchema().multiple(8) // 16 => ok, 12 => fail
schema.multiple() // to remove setting

And with a reference:

const ref = new Reference(15)
const schema = new NumberSchema().multiple(ref)

The reference should point to a numerical value.

2.5. format(string)

By setting one of the following format strings you will get the value back as a formatted string:

You can also add the unit if set earlier by adding $unit to the format string.

const schema = new NumberSchema().unit('cm').format('0.00 $unit')
schema.format() // to remove setting

And last but not least use $best to let the system change the unit to the best selection:

const schema = new NumberSchema().unit('cm').format('0.00 $best')
// value 16000 -> '160.00 m'

The format can also be given as reference:

const ref = new Reference('0.00 $unit')
const schema = new NumberSchema().unit('cm').format(ref)