time-to-botec/js/node_modules/@stdlib/assert/is-finite/README.md

isFinite

Test if a value is a finite number.

Usage

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

isFinite( value )

Tests if a value is a finite number.

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

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

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

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

bool = isFinite( null );
// returns false

isFinite.isPrimitive( value )

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

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

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

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

isFinite.isObject( value )

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

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

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

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

Notes

• In contrast to the built-in isFinite, input values are not coerced to numbers.

Examples

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

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

bool = isFinite( 0.0 );
// returns true

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

bool = isFinite( 5.256 );
// returns true

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

bool = isFinite( -1.0/0.0 );
// returns false

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

bool = isFinite( null );
// returns false