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

75 lines
1.4 KiB
Plaintext
Raw Normal View History

{{alias}}( value )
Tests if a value is positive zero.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether a value is positive zero.
Examples
--------
> var bool = {{alias}}( 0.0 )
true
> bool = {{alias}}( new Number( 0.0 ) )
true
> bool = {{alias}}( -3.14 )
false
> bool = {{alias}}( -0.0 )
false
> bool = {{alias}}( null )
false
{{alias}}.isPrimitive( value )
Tests if a value is a number primitive equal to positive zero.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether a value is a number primitive equal to
positive zero.
Examples
--------
> var bool = {{alias}}.isPrimitive( 0.0 )
true
> bool = {{alias}}.isPrimitive( new Number( 0.0 ) )
false
{{alias}}.isObject( value )
Tests if a value is a number object having a value equal to positive zero.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether a value is a number object having a value
equal to positive zero.
Examples
--------
> var bool = {{alias}}.isObject( 0.0 )
false
> bool = {{alias}}.isObject( new Number( 0.0 ) )
true
See Also
--------