@stdlib/assert-is-integer
v0.2.2
Published
Test if a value is a number having an integer value.
Downloads
317,575
Readme
isInteger
Test if a value is a number having an integer value.
Installation
npm install @stdlib/assert-is-integer
Usage
var isInteger = require( '@stdlib/assert-is-integer' );
isInteger( value )
Tests if a value is a number
having an integer
value.
var Number = require( '@stdlib/number-ctor' );
var bool = isInteger( 5.0 );
// returns true
bool = isInteger( new Number( 5.0 ) );
// returns true
bool = isInteger( -3.14 );
// returns false
bool = isInteger( null );
// returns false
isInteger.isPrimitive( value )
Tests if a value
is a primitive number
having an integer
value.
var Number = require( '@stdlib/number-ctor' );
var bool = isInteger.isPrimitive( -3.0 );
// returns true
bool = isInteger.isPrimitive( new Number( -3.0 ) );
// returns false
isInteger.isObject( value )
Tests if a value
is a Number
object having an integer
value.
var Number = require( '@stdlib/number-ctor' );
var bool = isInteger.isObject( 3.0 );
// returns false
bool = isInteger.isObject( new Number( 3.0 ) );
// returns true
Examples
var Number = require( '@stdlib/number-ctor' );
var isInteger = require( '@stdlib/assert-is-integer' );
var bool = isInteger( -5.0 );
// returns true
bool = isInteger( 0.0 );
// returns true
bool = isInteger( new Number( 5.0 ) );
// returns true
bool = isInteger( 5.256 );
// returns false
bool = isInteger( 1.0/0.0 );
// returns false
bool = isInteger( -1.0/0.0 );
// returns false
bool = isInteger( '5' );
// returns false
bool = isInteger( null );
// returns false
See Also
@stdlib/assert-is-number
: test if a value is a number.
Notice
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.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.