time-to-botec/squiggle/node_modules/@stdlib/assert/is-number-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

74 lines
1.5 KiB
Plaintext

{{alias}}( value )
Tests if a value is an array-like object containing only numbers.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether value is an array-like object containing only
numbers.
Examples
--------
> var bool = {{alias}}( [ 1, 2, 3 ] )
true
> bool = {{alias}}( [ '1', 2, 3 ] )
false
{{alias}}.primitives( value )
Tests if a value is an array-like object containing only number primitives.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether value is an array-like object containing only
number primitives.
Examples
--------
> var arr = [ 1, 2, 3 ];
> var bool = {{alias}}.primitives( arr )
true
> arr = [ 1, new Number( 2 ) ];
> bool = {{alias}}.primitives( arr )
false
{{alias}}.objects( value )
Tests if a value is an array-like object containing only `Number` objects.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether value is an array-like object containing only
`Number` objects.
Examples
--------
> var arr = [ new Number( 1 ), new Number( 2 ) ];
> var bool = {{alias}}.objects( arr )
true
> arr = [ new Number( 1 ), 2 ];
> bool = {{alias}}.objects( arr )
false
See Also
--------