@stdlib/assert-is-positive-zero

isPositiveZero

Test if a value is a number equal to positive zero.

Installation

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

Usage

var isPositiveZero = require( '@stdlib/assert-is-positive-zero' );

isPositiveZero( value )

Tests if a value is a number having a value equal to positive zero.

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

var bool = isPositiveZero( 0.0 );
// returns true

bool = isPositiveZero( new Number( 0.0 ) );
// returns true

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

bool = isPositiveZero( -0.0 );
// returns false

bool = isPositiveZero( null );
// returns false

isPositiveZero.isPrimitive( value )

Tests if a value is a primitive number equal to positive zero.

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

var bool = isPositiveZero.isPrimitive( 0.0 );
// returns true

bool = isPositiveZero.isPrimitive( new Number( 0.0 ) );
// returns false

isPositiveZero.isObject( value )

Tests if a value is a Number object having a value equal to positive zero.

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

var bool = isPositiveZero.isObject( 0.0 );
// returns false

bool = isPositiveZero.isObject( new Number( 0.0 ) );
// returns true

Examples

var Number = require( '@stdlib/number-ctor' );
var isPositiveZero = require( '@stdlib/assert-is-positive-zero' );

var bool = isPositiveZero( 0.0 );
// returns true

bool = isPositiveZero( new Number( 0.0 ) );
// returns true

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

bool = isPositiveZero( -0.0 );
// returns false

bool = isPositiveZero( 5.0 );
// returns false

bool = isPositiveZero( '0' );
// returns false

bool = isPositiveZero( null );
// returns false

See Also

• @stdlib/assert/is-number: test if a value is a number.
• @stdlib/assert/is-negative-zero: test if a value is equal to negative zero.

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.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2022. The Stdlib Authors.