2.7 KiB
2.7 KiB
isNonNegativeNumber
Test if a value is a number having a nonnegative value.
Usage
var isNonNegativeNumber = require( '@stdlib/assert/is-nonnegative-number' );
isNonNegativeNumber( value )
Tests if a value
is a number
having a nonnegative value.
var Number = require( '@stdlib/number/ctor' );
var bool = isNonNegativeNumber( 5.0 );
// returns true
bool = isNonNegativeNumber( new Number( 5.0 ) );
// returns true
bool = isNonNegativeNumber( 3.14 );
// returns true
bool = isNonNegativeNumber( -5.0 );
// returns false
bool = isNonNegativeNumber( null );
// returns false
isNonNegativeNumber.isPrimitive( value )
Tests if a value
is a primitive number
having a nonnegative value.
var Number = require( '@stdlib/number/ctor' );
var bool = isNonNegativeNumber.isPrimitive( 3.0 );
// returns true
bool = isNonNegativeNumber.isPrimitive( new Number( 3.0 ) );
// returns false
isNonNegativeNumber.isObject( value )
Tests if a value
is a Number
object having a nonnegative value.
var Number = require( '@stdlib/number/ctor' );
var bool = isNonNegativeNumber.isObject( 3.0 );
// returns false
bool = isNonNegativeNumber.isObject( new Number( 3.0 ) );
// returns true
Examples
var Number = require( '@stdlib/number/ctor' );
var isNonNegativeNumber = require( '@stdlib/assert/is-nonnegative-number' );
var bool = isNonNegativeNumber( 5.0 );
// returns true
bool = isNonNegativeNumber( new Number( 5.0 ) );
// returns true
bool = isNonNegativeNumber( 0.0 );
// returns true
bool = isNonNegativeNumber( 3.14 );
// returns true
bool = isNonNegativeNumber( -5.0 );
// returns false
bool = isNonNegativeNumber( '5' );
// returns false
bool = isNonNegativeNumber( null );
// returns false