npm install @stdlib/assert-is-safe-integer

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch.
• If you are using Deno, visit the deno branch.
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch.

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

var isSafeInteger = require( '@stdlib/assert-is-safe-integer' );

Tests if a value is a number having a safe integer value.

var Number = require( '@stdlib/number-ctor' ); var bool = isSafeInteger( 5.0 ); // returns true bool = isSafeInteger( new Number( 5.0 ) ); // returns true bool = isSafeInteger( 2.0e200 ); // returns false bool = isSafeInteger( -3.14 ); // returns false bool = isSafeInteger( null ); // returns false

Tests if a value is a primitive number having a safe integer value.

var Number = require( '@stdlib/number-ctor' ); var bool = isSafeInteger.isPrimitive( -3.0 ); // returns true bool = isSafeInteger.isPrimitive( new Number( -3.0 ) ); // returns false

Tests if a value is a Number object having a safe integer value.

var Number = require( '@stdlib/number-ctor' ); var bool = isSafeInteger.isObject( 3.0 ); // returns false bool = isSafeInteger.isObject( new Number( 3.0 ) ); // returns true

• An integer valued number is "safe" when the number can be exactly represented as a double-precision floating-point number. For example,

  var MAX_SAFE_INTEGER = require( '@stdlib/constants-float64-max-safe-integer' ); // returns 9007199254740991 var x = 9007199254740992; // returns 9007199254740992 var y = 9007199254740993; // returns 9007199254740992 var bool = ( x === y ); // returns true

  In this example, x and y should be distinct, but they are not due to constraints imposed by storing numeric values in double-precision floating-point format. "Safe" integers are thus double-precision floating-point numbers having integer values with unequivocal binary representations.

• @stdlib/assert-is-integer: test if a value is a number having an integer value.
• @stdlib/assert-is-number: test if a value is a number.

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

See LICENSE.

Copyright © 2016-2023. The Stdlib Authors.