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

isNonPositiveNumberArray

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

Usage

var isNonPositiveNumberArray = require( '@stdlib/assert/is-nonpositive-number-array' );

isNonPositiveNumberArray( value )

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

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

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

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

isNonPositiveNumberArray.primitives( value )

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

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

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

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

isNonPositiveNumberArray.objects( value )

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

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

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

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

Examples

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

var bool = isNonPositiveNumberArray( [ -5.0, -0.2, -3.9 ] );
// returns true

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

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

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

bool = isNonPositiveNumberArray( -78.0 );
// returns false