@stdlib/assert-is-nonpositive-integer NPM

isNonPositiveInteger

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

Installation

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

Usage

var isNonPositiveInteger = require( '@stdlib/assert-is-nonpositive-integer' );

isNonPositiveInteger( value )

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

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

var bool = isNonPositiveInteger( -5.0 );
// returns true

bool = isNonPositiveInteger( new Number( -5.0 ) );
// returns true

bool = isNonPositiveInteger( 5.0 );
// returns false

bool = isNonPositiveInteger( -3.14 );
// returns false

bool = isNonPositiveInteger( null );
// returns false

isNonPositiveInteger.isPrimitive( value )

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

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

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

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

isNonPositiveInteger.isObject( value )

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

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

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

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

Examples

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

var bool = isNonPositiveInteger( -5.0 );
// returns true

bool = isNonPositiveInteger( new Number( -5.0 ) );
// returns true

bool = isNonPositiveInteger( 0.0 );
// returns true

bool = isNonPositiveInteger( -3.14 );
// returns false

bool = isNonPositiveInteger( 5.0 );
// returns false

bool = isNonPositiveInteger( '-5' );
// returns false

bool = isNonPositiveInteger( 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.