time-to-botec/js/node_modules/@stdlib/assert/is-finite-array/docs/repl.txt
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

76 lines
1.6 KiB
Plaintext

{{alias}}( value )
Tests if a value is an array-like object of finite numbers.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether a value is an array-like object of finite
numbers.
Examples
--------
> var bool = {{alias}}( [ -3.0, new Number(0.0), 2.0 ] )
true
> bool = {{alias}}( [ -3.0, 1.0/0.0 ] )
false
{{alias}}.primitives( value )
Tests if a value is an array-like object containing only primitive finite
numbers.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether a value is an array-like object containing
only primitive finite numbers.
Examples
--------
> var bool = {{alias}}.primitives( [ -1.0, 10.0 ] )
true
> bool = {{alias}}.primitives( [ -1.0, 0.0, 5.0 ] )
true
> bool = {{alias}}.primitives( [ -3.0, new Number(-1.0) ] )
false
{{alias}}.objects( value )
Tests if a value is an array-like object containing only number objects
having finite values.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether a value is an array-like object containing
only number objects having finite values.
Examples
--------
> var bool = {{alias}}.objects( [ new Number(1.0), new Number(3.0) ] )
true
> bool = {{alias}}.objects( [ -1.0, 0.0, 3.0 ] )
false
> bool = {{alias}}.objects( [ 3.0, new Number(-1.0) ] )
false
See Also
--------