time-to-botec/squiggle/node_modules/@stdlib/assert/is-integer-array/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

2.8 KiB

isIntegerArray

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

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