isNonNegativeInteger

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

Usage

var isNonNegativeInteger = require( '@stdlib/utils/is-nonnegative-integer' );

isNonNegativeInteger( value )

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

var bool = isNonNegativeInteger( 5.0 );
// returns true

bool = isNonNegativeInteger( new Number( 5.0 ) );
// returns true

bool = isNonNegativeInteger( -5.0 );
// returns false

bool = isNonNegativeInteger( 3.14 );
// returns false

bool = isNonNegativeInteger( null );
// returns false

isNonNegativeInteger.isPrimitive( value )

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

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

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

isNonNegativeInteger.isObject( value )

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

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

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

isNonNegativeInteger.isNonNegativeIntegerArray( value )

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

var bool = isNonNegativeInteger.isNonNegativeIntegerArray( [ 3.0, new Number(3.0) ] );
// returns true

bool = isNonNegativeInteger.isNonNegativeIntegerArray( [ 3.0, '3.0' ] );
// returns false

isNonNegativeInteger.isNonNegativePrimitiveIntegerArray( value )

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

var bool = isNonNegativeInteger.isNonNegativePrimitiveIntegerArray( [ 1.0, 0.0, 10.0 ] );
// returns true

bool = isNonNegativeInteger.isNonNegativePrimitiveIntegerArray( [ 3.0, new Number(1.0) ] );
// returns false

Examples

var isNonNegativeInteger = require( '@stdlib/utils/is-nonnegative-integer' );

console.log( isNonNegativeInteger( 5.0 ) );
// returns true

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

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

console.log( isNonNegativeInteger( 3.14 ) );
// returns false

console.log( isNonNegativeInteger( -5.0 ) );
// returns false

console.log( isNonNegativeInteger( '5' ) );
// returns false

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