@stdlib/iter
Version:
Standard iterator utilities.
39 lines (27 loc) • 1.01 kB
Plain Text
{{alias}}( iterFcn[, ...args] )
Returns an iterator "thunk".
A provided iterator function should have the following function signature:
iterFcn( iterator, ...args )
The returned function expects a single argument, an iterator.
This function is useful within the context of iterator pipelines as a means
to defer execution until a pipeline is ready for data flow.
Parameters
----------
iterFcn: Function
Iterator function.
args: ...any (optional)
Function arguments.
Returns
-------
fcn( iter ): Function
Function which accepts a single argument, an iterator, and invokes a
previously provided iterator function with the provided iterator and any
previously provided arguments.
Examples
--------
> var fcn = {{alias}}( {{alias:/iter/some}}, 3 );
> var arr = {{alias:/array/to-iterator}}( [ 0, 0, 1, 1, 1 ] );
> var bool = fcn( arr )
true
See Also
--------