time-to-botec/js/node_modules/@stdlib/utils/none/docs/repl.txt

30 lines
725 B
Plaintext
Raw Normal View History

{{alias}}( collection )
Tests whether all elements in a collection are falsy.
The function immediately returns upon encountering a truthy value.
If provided an empty collection, the function returns `true`.
Parameters
----------
collection: Array|TypedArray|Object
Input collection over which to iterate. If provided an object, the
object must be array-like (excluding strings and functions).
Returns
-------
bool: boolean
The function returns `true` if all elements are falsy; otherwise, the
function returns `false`.
Examples
--------
> var arr = [ 0, 0, 0, 0, 0 ];
> var bool = {{alias}}( arr )
true
See Also
--------