@stdlib/assert-is-safe-integer-array

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

Usage no npm install needed!

<script type="module">
  import stdlibAssertIsSafeIntegerArray from 'https://cdn.skypack.dev/@stdlib/assert-is-safe-integer-array';
</script>

README

isSafeIntegerArray

NPM version Build Status Coverage Status

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

Installation

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

Usage

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

isSafeIntegerArray( value )

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

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

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

bool = isSafeIntegerArray( [ -1e100, 2e200 ] );
// returns false

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

isSafeIntegerArray.primitives( value )

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

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

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

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

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

isSafeIntegerArray.objects( value )

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

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

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

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

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

Examples

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

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

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

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

bool = isSafeIntegerArray( [ 1e100, 2e200, 3e300 ] );
// returns false

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

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

bool = isSafeIntegerArray( [] );
// 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-2022. The Stdlib Authors.