Skip to content

Latest commit

 

History

History

is-nonpositive-integer

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

isNonPositiveInteger

Test if a value is a number having a nonpositive integer value.

## Usage
var isNonPositiveInteger = require( '@stdlib/utils/is-nonpositive-integer' );

isNonPositiveInteger( value )

Tests if a value is a number having a nonpositive integer value.

var bool = isNonPositiveInteger( -5.0 );
// returns true

bool = isNonPositiveInteger( new Number( -5.0 ) );
// returns true

bool = isNonPositiveInteger( 5.0 );
// returns false

bool = isNonPositiveInteger( -3.14 );
// returns false

bool = isNonPositiveInteger( null );
// returns false

isNonPositiveInteger.isPrimitive( value )

Tests if a value is a primitive number having a nonpositive integer value.

var bool = isNonPositiveInteger.isPrimitive( -3.0 );
// returns true

bool = isNonPositiveInteger.isPrimitive( new Number( -3.0 ) );
// returns false

isNonPositiveInteger.isObject( value )

Tests if a value is a Number object having a nonpositive integer value.

var bool = isNonPositiveInteger.isObject( -3.0 );
// returns false

bool = isNonPositiveInteger.isObject( new Number( -3.0 ) );
// returns true

isNonPositiveInteger.isNonPositiveIntegerArray( value )

Tests if a value is a number array having only nonpositive integer values.

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

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

isNonPositiveInteger.isNonPositivePrimitiveIntegerArray( value )

Tests if a value is a primitive number array having only nonpositiveinteger values.

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

bool = isNonPositiveInteger.isNonPositivePrimitiveIntegerArray( [ -3.0, new Number(-1.0) ] );
// returns false
## Examples
var isNonPositiveInteger = require( '@stdlib/utils/is-nonpositive-integer' );

console.log( isNonPositiveInteger( -5.0 ) );
// returns true

console.log( isNonPositiveInteger( new Number( -5.0 ) ) );
// returns true

console.log( isNonPositiveInteger( 0.0 ) );
// returns true

console.log( isNonPositiveInteger( -3.14 ) );
// returns false

console.log( isNonPositiveInteger( 5.0 ) );
// returns false

console.log( isNonPositiveInteger( '-5' ) );
// returns false

console.log( isNonPositiveInteger( null ) );
// returns false