isPositiveInteger

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

Usage

var isPositiveInteger = require( '@stdlib/utils/is-positive-integer' );

isPositiveInteger( value )

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

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

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

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

bool = isPositiveInteger( 0.0 );
// returns false

bool = isPositiveInteger( 3.14 );
// returns false

bool = isPositiveInteger( null );
// returns false

isPositiveInteger.isPrimitive( value )

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

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

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

isPositiveInteger.isObject( value )

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

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

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

Examples

var isPositiveInteger = require( '@stdlib/utils/is-positive-integer' );

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

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

bool = isPositiveInteger( 0.0 );
// returns false

bool = isPositiveInteger( 3.14 );
// returns false

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

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

bool = isPositiveInteger( null );
// returns false