time-to-botec/squiggle/node_modules/@stdlib/array/to-circular-iterator/docs/repl.txt

66 lines
1.8 KiB
Plaintext
Raw Normal View History

{{alias}}( src[, options][, mapFcn[, thisArg]] )
Returns an iterator which repeatedly iterates over the elements of an array-
like object.
When invoked, an input function is provided four arguments:
- value: iterated value
- index: iterated value index
- n: iteration count
- src: source array-like object
If an environment supports Symbol.iterator, the returned iterator is
iterable.
If an environment supports Symbol.iterator, the function explicitly does not
not invoke an array's `@@iterator` method, regardless of whether this method
is defined. To convert an array to an implementation defined iterator,
invoke this method directly.
Parameters
----------
src: ArrayLikeObject
Array-like object from which to create the iterator.
options: Object (optional)
Function options.
options.iter: integer (optional)
Number of iterations. Default: 1e308.
options.dir: integer (optional)
Iteration direction. If set to `-1`, an iterator iterates over elements
from right-to-left. Default: 1.
mapFcn: Function (optional)
Function to invoke for each iterated value.
thisArg: any (optional)
Execution context.
Returns
-------
iterator: Object
Iterator.
iterator.next(): Function
Returns an iterator protocol-compliant object containing the next
iterated value (if one exists) and a boolean flag indicating whether the
iterator is finished.
iterator.return( [value] ): Function
Finishes an iterator and returns a provided value.
Examples
--------
> var it = {{alias}}( [ 1, 2, 3, 4 ] );
> var v = it.next().value
1
> v = it.next().value
2
See Also
--------