time-to-botec/squiggle/node_modules/@stdlib/utils/for-each/docs/repl.txt

41 lines
930 B
Plaintext
Raw Normal View History

{{alias}}( collection, fcn[, thisArg] )
Invokes a function for each element in a collection.
When invoked, the input function is provided three arguments:
- `value`: collection value
- `index`: collection index
- `collection`: the input collection
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).
fcn: Function
The function to invoke for each element in a collection.
thisArg: any (optional)
Execution context.
Returns
-------
out: Array|TypedArray|Object
Input collection.
Examples
--------
> function logger( v, i ) { console.log( '%s: %d', i, v ); };
> var arr = [ 1, 2, 3, 4 ];
> {{alias}}( arr, logger )
0: 1
1: 2
2: 3
3: 4
See Also
--------