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

isPositiveInteger.isPositiveIntegerArray( value )

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

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

bool = isPositiveInteger.isPositiveIntegerArray( [ 3.0, '3.0' ] );
// returns false

isPositiveInteger.isPositivePrimitiveIntegerArray( value )

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

var bool = isPositiveInteger.isPositivePrimitiveIntegerArray( [ 1.0, 2.0, 10.0 ] );
// returns true

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

Examples

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

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

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

console.log( isPositiveInteger( 0.0 ) );
// returns false

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

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

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

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