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

48 lines
1.2 KiB
Plaintext
Raw Normal View History

{{alias}}( collection, predicate, fcn[, thisArg] )
While a test condition is true, invokes a function for each element in a
collection.
When invoked, both the predicate function and the function to apply are
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).
predicate: Function
The predicate function which indicates whether to continue iterating
over a collection.
fcn: Function
The function to invoke for each element in a collection.
thisArg: any (optional)
Execution context for the applied function.
Returns
-------
out: Array|TypedArray|Object
Input collection.
Examples
--------
> function predicate( v ) { return v === v; };
> function logger( v, i ) { console.log( '%s: %d', i, v ); };
> var arr = [ 1, 2, 3, 4, NaN, 5 ];
> {{alias}}( arr, predicate, logger )
0: 1
1: 2
2: 3
3: 4
See Also
--------