8000 GitHub - stdlib-js/assert-is-integer at 6f3be99b0568545247838e50029c06629f2565cb
[go: up one dir, main page]

Skip to content

stdlib-js/assert-is-integer

Repository files navigation

isInteger

NPM version Build Status Coverage Status

Test if a value is a number having an integer value.

Installation

npm install @stdlib/assert-is-integer

Alternatively,

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

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


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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2023. The Stdlib Authors.

0