isIntegerArray

Test if a value is an array-like object containing only integers.

Installation

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

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.

Usage

var isIntegerArray = require( '@stdlib/assert-is-integer-array' );

isIntegerArray( value )

Tests if a value is an array-like object containing only integer values.

var Number = require( '@stdlib/number-ctor' );

var bool = isIntegerArray( [ -3, new Number(3) ] );
// returns true

bool = isIntegerArray( [ -3, 'abc' ] );
// returns false

isIntegerArray.primitives( value )

Tests if a value is an array-like object containing only primitive integer values.

var Number = require( '@stdlib/number-ctor' );

var bool = isIntegerArray.primitives( [ -1.0, 0.0, 4.0 ] );
// returns true

bool = isIntegerArray.primitives( [ -1.0, 2.2 ] );
// returns false

bool = isIntegerArray.primitives( [ -3.0, new Number(2.0) ] );
// returns false

isIntegerArray.objects( value )

Tests if a value is an array-like object containing only Number objects having integer values.

var Number = require( '@stdlib/number-ctor' );

var bool = isIntegerArray.objects( [ new Number(-1.0), new Number(2.0) ] );
// returns true

bool = isIntegerArray.objects( [ -1.0, 0.0, 1.0 ] );
// returns false

bool = isIntegerArray.objects( [ -3.0, new Number(1.0) ] );
// returns false

Examples

var Number = require( '@stdlib/number-ctor' );
var isIntegerArray = require( '@stdlib/assert-is-integer-array' );

var bool = isIntegerArray( [ -5, 0, 2, 5 ] );
// returns true

bool = isIntegerArray( [ -4, -3, 1, 3 ] );
// returns true

bool = isIntegerArray( [ -1, new Number( -6 ), 2 ] );
// returns true

bool = isIntegerArray( [ -1, 'abc', 3 ] );
// returns false

bool = isIntegerArray( [ -2.3, 0, 3 ] );
// returns false

bool = isIntegerArray( [] );
// returns false

---

See Also

• @stdlib/assert/is-array: test if a value is an array.

---

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-2022. The Stdlib Authors.