Back to Functions

isNumber

lang

Checks if value is classified as a Number primitive or object.

Installation

Import
import { isNumber } from '@tulx/utils';

Source Code

Implementation
/**
 * Checks if value is classified as a Number primitive or object.
 *
 * @param value - The value to check.
 * @returns Returns true if value is a number, else false.
 *
 * @example
 * ```ts
 * isNumber(3); // true
 * isNumber(Number.MIN_VALUE); // true
 * isNumber(Infinity); // true
 * isNumber('3'); // false
 * ```
 */
export function isNumber(value: unknown): value is number {
  return typeof value === 'number' || value instanceof Number;
}

Example

import { isNumber } from '@tulx/utils';

isNumber(3); // true
isNumber(Number.MIN_VALUE); // true
isNumber(Infinity); // true
isNumber('3'); // false

Related Functions