number

Creates a number schema.

const Schema = v.number<TMessage>(message);

Generics

With number you can validate the data type of the input. If the input is not a number, you can use message to customize the error message.

The following examples show how number can be used.

Schema to validate an integer.

const IntegerSchema = v.pipe(v.number(), v.integer());

Schema that forces a minimum number of 10.

const MinNumberSchema = v.pipe(v.number(), v.toMinValue(10));

Schema that validates a number in a range.

const NumberRangeSchema = v.pipe(v.number(), v.minValue(10), v.maxValue(20));

The following APIs can be combined with number.