@zerodep/guard-number

A run-time guard to require a value to be a number; it will throw a ZeroDepError if the guard fails.

Full documentation is available at the zerodep.app page.

Examples

All @zerodep packages support both ESM and CJS.

import { guardNumber } from '@zerodep/guard-number';
// or
const { guardNumber } = require('@zerodep/guard-number');

Successful Cases

guardNumber(3.14); // void
guardNumber(42); // void

Unsuccessful Cases

guardNumber([]); // throws ZeroDepError: Value is not a number
guardNumber(['a', 'b', 'c']); // throws ZeroDepError: Value is not a number
guardNumber(1000n); // throws ZeroDepError: Value is not a number
guardNumber(true); // throws ZeroDepError: Value is not a number
guardNumber(new Date()); // throws ZeroDepError: Value is not a number
guardNumber(''); // throws ZeroDepError: Value is not a number
guardNumber(new Error('message')); // throws ZeroDepError: Value is not a number
guardNumber(() => 'function'); // throws ZeroDepError: Value is not a number
guardNumber(
  new Map([
    ['a', 1],
    ['b', 2],
  ])
); // throws ZeroDepError: Value is not a number
guardNumber(null); // throws ZeroDepError: Value is not a number
guardNumber({ an: 'object' }); // throws ZeroDepError: Value is not a number
guardNumber(new Promise(() => {})); // throws ZeroDepError: Value is not a number
guardNumber(/[regex]+/gi); // throws ZeroDepError: Value is not a number
guardNumber(new Set([1, 2, 3])); // throws ZeroDepError: Value is not a number
guardNumber('a string'); // throws ZeroDepError: Value is not a number
guardNumber(Symbol()); // throws ZeroDepError: Value is not a number
guardNumber(new Int32Array(2)); // throws ZeroDepError: Value is not a number
guardNumber(undefined); // throws ZeroDepError: Value is not a number