@stdlib/assert-is-positive-integer-array
v0.2.2
Published
Test if a value is an array-like object containing only positive integers.
Downloads
2,483
Readme
isPositiveIntegerArray
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
See Also
@stdlib/assert-is-array
: test if a value is an array.@stdlib/assert-is-integer
: test if a value is a number having an integer value.@stdlib/assert-is-positive-integer
: test if a value is a number having a positive integer value.
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.