isPositiveFinite

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

Installation

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

Usage

var isPositiveFinite = require( '@stdlib/assert-is-positive-finite' );

isPositiveFinite( value )

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

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

var bool = isPositiveFinite( 5.0 );
// returns true

bool = isPositiveFinite( new Number( 5.0 ) );
// returns true

bool = isPositiveFinite( 1.0/0.0 );
// returns false

bool = isPositiveFinite( -5.0 );
// returns false

bool = isPositiveFinite( new Number( 1.0/0.0 ) );
// returns false

bool = isPositiveFinite( null );
// returns false

isPositiveFinite.isPrimitive( value )

Tests if a value is a primitive number having a finite positive value.

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

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

bool = isPositiveFinite.isPrimitive( 3.0/0.0 );
// returns false

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

isPositiveFinite.isObject( value )

Tests if a value is a Number object having a finite positive value.

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

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

bool = isPositiveFinite.isObject( 3.0 );
// returns false

bool = isPositiveFinite.isObject( new Number( 1.0/0.0 ) );
// returns false

Examples

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

var bool = isPositiveFinite( 5.0 );
// returns true

bool = isPositiveFinite( new Number( 5.0 ) );
// returns true

bool = isPositiveFinite( 3.14 );
// returns true

bool = isPositiveFinite( 0.0 );
// returns false

bool = isPositiveFinite( 1.0/0.0 );
// returns false

bool = isPositiveFinite( new Number( 1.0/0.0 ) );
// returns false

bool = isPositiveFinite( -5.0 );
// returns false

bool = isPositiveFinite( '5' );
// returns false

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

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.