time-to-botec/js/node_modules/@stdlib/assert/is-positive-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

isPositiveIntegerArray

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

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