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

32 lines
572 B
Plaintext
Raw Normal View History

{{alias}}( value )
Tests if a value is a valid array length.
A valid length property for an Array instance is any integer value on the
interval [0, 2^32-1].
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether value is a valid array length.
Examples
--------
> var bool = {{alias}}( 5 )
true
> bool = {{alias}}( 2.0e200 )
false
> bool = {{alias}}( -3.14 )
false
> bool = {{alias}}( null )
false
See Also
--------