time-to-botec/js/node_modules/@stdlib/assert/is-safe-integer/docs/repl.txt

78 lines
1.5 KiB
Plaintext
Raw Permalink Normal View History

{{alias}}( value )
Tests if a value is a safe integer.
An integer valued number is "safe" when the number can be exactly
represented as a double-precision floating-point number.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether value is a safe integer.
Examples
--------
> var bool = {{alias}}( 5.0 )
true
> bool = {{alias}}( new Number( 5.0 ) )
true
> bool = {{alias}}( 2.0e200 )
false
> bool = {{alias}}( -3.14 )
false
> bool = {{alias}}( null )
false
{{alias}}.isPrimitive( value )
Tests if a value is a number primitive having a safe integer value.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether value is a number primitive having a safe
integer value.
Examples
--------
> var bool = {{alias}}.isPrimitive( -3.0 )
true
> bool = {{alias}}.isPrimitive( new Number( -3.0 ) )
false
{{alias}}.isObject( value )
Tests if a value is a `Number` object having a safe integer value.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether value is a `Number` object having a safe
integer value.
Examples
--------
> var bool = {{alias}}.isObject( 3.0 )
false
> bool = {{alias}}.isObject( new Number( 3.0 ) )
true
See Also
--------