@stdlib/assert-is-integer-array
v0.2.2
Published
Test if a value is an array-like object containing only integers.
Downloads
9,221
Readme
isIntegerArray
Test if a value is an array-like object containing only integers.
Installation
npm install @stdlib/assert-is-integer-array
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-2024. The Stdlib Authors.