History

NunoSempere b6addc7f05 feat: add the node modules Necessary in order to clearly see the squiggle hotwiring.		2022-12-03 12:44:49 +00:00
..
docs	feat: add the node modules	2022-12-03 12:44:49 +00:00
lib	feat: add the node modules	2022-12-03 12:44:49 +00:00
package.json	feat: add the node modules	2022-12-03 12:44:49 +00:00
README.md	feat: add the node modules	2022-12-03 12:44:49 +00:00

README.md

isNonPositiveInteger

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

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