isNumber

isNumber

Verifies if provided Verificable represents a value that is a number. Only values that are JS numbers are matching, so string values like "123", or other values coercing to a number will not match this Predicate.

The check internally is done by checking the type of the value typeof value === "number".

Possible errors:

If provided Verificable is not a number:

{
    type: "isNumber",
    path: [/* ... */]
}

Examples:

Each of examples uses this import statement:

const { asVerificable, isValid, isNumber } = require("verifica");

Null or undefined is not considered a number:

const verificable = asVerificable(null);
isValid(verificable, isNumber); // false

String value is not considered a number as well:

const verificable = asVerificable("123");
isValid(verificable, isNumber); // false

Infinity, -Infinity, or NaN are considered numbers:

const verificable = asVerificable(Infinity);
isValid(verificable, isNumber); // true

Other numbers are considered numbers:

const verificable = asVerificable(12345.67);
isValid(verificable, isNumber); // true