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

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

Usage no npm install needed!

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

README

isPositiveIntegerArray

NPM version Build Status Coverage Status

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

Installation

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

Usage

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

isPositiveIntegerArray( value )

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

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

var bool = isPositiveIntegerArray( [ 3.0, new Number(3.0) ] );
// returns true

bool = isPositiveIntegerArray( [ 3.0, '3.0' ] );
// returns false

isPositiveIntegerArray.primitives( value )

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

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

var bool = isPositiveIntegerArray.primitives( [ 1.0, 2.0, 10.0 ] );
// returns true

bool = isPositiveIntegerArray.primitives( [ 3.0, new Number(1.0) ] );
// returns false

isPositiveIntegerArray.objects( value )

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

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

var bool = isPositiveIntegerArray.objects( [ new Number(3.0), new Number(1.0) ] );
// returns true

bool = isPositiveIntegerArray.objects( [ 1.0, 2.0, 10.0 ] );
// returns false

Examples

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

var bool = isPositiveIntegerArray( [ 5, 2, 3 ] );
// returns true

bool = isPositiveIntegerArray( [ 1, new Number( 6 ), 3 ] );
// returns true

bool = isPositiveIntegerArray( [ 0, 1, 2, 3, 4 ] );
// returns false

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

bool = isPositiveIntegerArray( [ 2.3, 1, 3 ] );
// returns false

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

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.