time-to-botec/squiggle/node_modules/@stdlib/assert/is-infinite/docs/repl.txt

73 lines
1.4 KiB
Plaintext
Raw Normal View History

{{alias}}( value )
Tests if a value is an infinite number.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether a value is an infinite number.
Examples
--------
> var bool = {{alias}}( 1.0/0.0 )
true
> bool = {{alias}}( new Number( -1.0/0.0 ) )
true
> bool = {{alias}}( 5.0 )
false
> bool = {{alias}}( '1.0/0.0' )
false
{{alias}}.isPrimitive( value )
Tests if a value is a number primitive having an infinite value.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether a value is a number primitive having an
infinite value.
Examples
--------
> var bool = {{alias}}.isPrimitive( -1.0/0.0 )
true
> bool = {{alias}}.isPrimitive( new Number( -1.0/0.0 ) )
false
{{alias}}.isObject( value )
Tests if a value is a number object having an infinite value.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether a value is a number object having an infinite
value.
Examples
--------
> var bool = {{alias}}.isObject( 1.0/0.0 )
false
> bool = {{alias}}.isObject( new Number( 1.0/0.0 ) )
true
See Also
--------