isNonNegativeInteger

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

Usage

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

isNonNegativeInteger( value )

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

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

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 Number = require( '@stdlib/number/ctor' );

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 Number = require( '@stdlib/number/ctor' );

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

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

Examples

var Number = require( '@stdlib/number/ctor' );
var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' );

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

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

bool = isNonNegativeInteger( 0.0 );
// returns true

bool = isNonNegativeInteger( 3.14 );
// returns false

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

bool = isNonNegativeInteger( '5' );
// returns false

bool = isNonNegativeInteger( null );
// returns false

---

See Also

• @stdlib/assert/is-integer: test if a value is a number having an integer value.
• @stdlib/assert/is-nonnegative-number: test if a value is a number having a nonnegative value.
• @stdlib/assert/is-number: test if a value is a number.