@zerodep/is-number

A simple, performant utility to determine if a value is a finite number.

Full documentation is available at the zerodep.app page.

Signature

declare const isNumber: (value: unknown) => boolean;

Examples

All @zerodep packages support both ESM and CJS formats, each complete with Typescript typings.

// ESM
import { isNumber } from '@zerodep/is-number';

// CJS
const { isNumber } = require('@zerodep/is-number');

// Arrays
isNumber([]); // false
isNumber([1, 2, 3]); // false
isNumber(['a', 'b', 'c']); // false

// BigInts
isNumber(42n); // false
isNumber(0n); // false
isNumber(-0n); // false
isNumber(-42n); // false

// Booleans
isNumber(true); // false
isNumber(false); // false

// Class
isNumber(
  class SomeClass {
    constructor() {}
  }
); // false

// Dates
isNumber(new Date()); // false
isNumber(new Date('1970-01-01T12:00:00.000Z')); // false
isNumber(new Date('2099-12-31')); // false

// Empty
isNumber(null); // false
isNumber(undefined); // false

// Errors
isNumber(new Error('message')); // false
isNumber(new AggregateError([new Error('err1'), new Error('err2')], 'message')); // false

// Floats
isNumber(3.14); // true
isNumber(0.0); // true
isNumber(-0.0); // true
isNumber(-3.14); // true
isNumber(Math.E); // true
isNumber(Math.PI); // true
isNumber(Number.MIN_VALUE); // true

// Functions
isNumber(() => 'function'); // false
isNumber(async () => 'function'); // false

// Generators
isNumber(function* () {
  yield 'a';
}); // false
isNumber(async function* () {
  yield 'a';
}); // false

// Maps
isNumber(new Map()); // false
isNumber(new Map([['key1', 123]])); // false
isNumber(new Map([['key1', 'value1']])); // false

// Numbers
isNumber(Number.POSITIVE_INFINITY); // false  <-- CAUTION: infinite numbers are excluded
isNumber(Number.MAX_SAFE_INTEGER); // true
isNumber(3e8); // true
isNumber(42); // true
isNumber(1); // true
isNumber(0); // true
isNumber(-0); // true
isNumber(-1); // true
isNumber(-42); // true
isNumber(-3e8); // true
isNumber(Number.MIN_SAFE_INTEGER); // true
isNumber(Number.NEGATIVE_INFINITY); // false  <-- CAUTION: infinite numbers are excluded
isNumber(Number.NaN); // false

// POJOs
isNumber({}); // false
isNumber({ key: 'string' }); // false
isNumber({ key: 123 }); // false

// Promise
isNumber(new Promise(() => {})); // false
isNumber(new Promise.all([])); // false
isNumber(new Promise.allSettled([])); // false
isNumber(new Promise.race([])); // false
isNumber(Promise.resolve()); // false

// Regular Expression
isNumber(/[regex]+/gi); // false
isNumber(new RegExp('d', 'gi')); // false

// Sets
isNumber(new Set()); // false
isNumber(new Set([1, 2, 3])); // false
isNumber(new Set(['a', 'b', 'c'])); // false

// Strings
isNumber(''); // false
isNumber('a longer string'); // false
isNumber('1000n'); // false
isNumber('3e8'); // false
isNumber('42'); // false
isNumber('3.14'); // false
isNumber('0'); // false
isNumber('-0'); // false
isNumber('-3.14'); // false
isNumber('-42'); // false
isNumber('-3e8'); // false
isNumber('-1000n'); // false

// Symbols
isNumber(Symbol()); // false
isNumber(Symbol('name')); // false

// This
isNumber(this); // false
isNumber(globalThis); // false

// TypedArrays
isNumber(new Int8Array(2)); // false
isNumber(new Int16Array(2)); // false
isNumber(new Int32Array(2)); // false
isNumber(new Uint8Array(2)); // false
isNumber(new Uint16Array(2)); // false
isNumber(new Uint32Array(2)); // false
isNumber(new Uint8ClampedArray(2)); // false

isNumber(new BigInt64Array(2)); // false
isNumber(new BigUint64Array(2)); // false

isNumber(new Float32Array(2)); // false
isNumber(new Float64Array(2)); // false

isNumber(new SharedArrayBuffer(512)); // false

// WeakMap and WeakSet
isNumber(new WeakMap()); // false
isNumber(new WeakSet()); // false

ZeroDep Advantages

• Zero npm dependencies - completely eliminates all risk of supply-chain attacks, decreases node_modules folder size
• ESM & CJS - has both ecmascript modules and common javascript exports
• Tree Shakable - built to be fully tree shakable ensuring your packages are the smallest possible size
• Fully typed - typescript definitions are provided for every package for a better developer experience
• Semantically named - package and method names are easy to grok, remember, use, and read
• Documented - actually useful documentation with examples at zerodep.app
• Intelligently Packaged - multiple npm packages of different sizes available allowing a menu or a-la-carte composition of capabilities
• 100% Tested - all methods and packages are fully unit tested
• Predictably Versioned - semantically versioned for peace-of-mind upgrading, this includes changelogs
• MIT Licensed - permissively licensed for maximum usability