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

30 lines
535 B
Plaintext

{{alias}}( value )
Tests if a value is a collection.
A collection is defined as an array, typed array, or an array-like object
(excluding strings and functions).
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether a value is a collection.
Examples
--------
> var bool = {{alias}}( [] )
true
> bool = {{alias}}( { 'length': 0 } )
true
> bool = {{alias}}( {} )
false
See Also
--------