@stdlib/assert-is-positive-integer

isPositiveInteger

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

Installation

npm install @stdlib/assert-is-positive-integer

Usage

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

isPositiveInteger( value )

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

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

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

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

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

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

Examples

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

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

---

License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.

Changelog

0.0.2 (2021-06-15)

No changes reported for this release.

</section> <!-- /.release --> <section class="release" id="v0.0.1">