time-to-botec/js/node_modules/@stdlib/assert/is-nonpositive-integer-array/README.md

isNonPositiveIntegerArray

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

Usage

var isNonPositiveIntegerArray = require( '@stdlib/assert/is-nonpositive-integer-array' );

isNonPositiveIntegerArray( value )

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

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

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

bool = isNonPositiveIntegerArray( [ -3, '3.0' ] );
// returns false

isNonPositiveIntegerArray.primitives( value )

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

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

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

bool = isNonPositiveIntegerArray.primitives( [ -1.0, 0.0, -10.0 ] );
// returns true

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

isNonPositiveIntegerArray.objects( value )

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

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

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

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

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

Examples

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

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

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

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

bool = isNonPositiveIntegerArray( [ -3, -2, -1, 0 ] );
// returns true

bool = isNonPositiveIntegerArray( [ -3, -2, -1, 0, 2 ] );
// returns false

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

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

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