goog.iter

Provided By	`goog.iter`

Creates an iterator that returns running totals from the numbers in iterable. For example, the array [1, 2, 3, 4, 5] yields 1 -> 3 -> 6 -> 10 -> 15.

Parameters

`iterable`	`({length: number}\|{__iterator__: ?})`
	The iterable of numbers to accumulate.

Returns

goog.iter.Iterator<number>

A new iterator that returns the numbers in the series.

VIEW SOURCE

Takes zero or more iterables and returns one iterator that will iterate over them in the order chained.

Parameters

`var_args`	`...({length: number}\|{__iterator__: ?})`
	Any number of iterable objects.

Returns

goog.iter.Iterator<(VALUE|null)>

Returns a new iterator that will iterate over all the given iterables' contents.

VIEW SOURCE

Takes a single iterable containing zero or more iterables and returns one iterator that will iterate over each one in the order given.

Parameters

`iterable`	`({length: number}\|{__iterator__: ?}\|null)`
	The iterable of iterables to chain.

Returns

goog.iter.Iterator<(VALUE|null)>

Returns a new iterator that will iterate over all the contents of the iterables contained within iterable.

See Also

https://goo.gl/5NRp5d

VIEW SOURCE

Creates an iterator that returns combinations of elements from iterable.

Combinations are obtained by taking the goog.iter.permutations of iterable and filtering those whose elements appear in the order they are encountered in iterable. For example, the 3-length combinations of [0,1,2,3] are [[0,1,2], [0,1,3], [0,2,3], [1,2,3]].

Parameters

`iterable`	`({length: number}\|{__iterator__: ?})`
	The iterable from which to generate combinations.
`length`	`number`
	The length of each combination.

Returns

goog.iter.Iterator<Array<(VALUE|null)>>

A new iterator containing combinations from the iterable.

VIEW SOURCE

Creates an iterator that returns combinations of elements from iterable, with repeated elements possible.

Combinations are obtained by taking the Cartesian product of length iterables and filtering those whose elements appear in the order they are encountered in iterable. For example, the 2-length combinations of [1,2,3] are [[1,1], [1,2], [1,3], [2,2], [2,3], [3,3]].

Parameters

`iterable`	`({length: number}\|{__iterator__: ?})`
	The iterable to combine.
`length`	`number`
	The length of each combination.

Returns

goog.iter.Iterator<Array<(VALUE|null)>>

A new iterator containing combinations from the iterable.

See Also

https://goo.gl/C0yXe4

https://goo.gl/djOCsk

VIEW SOURCE

Creates an iterator that filters iterable based on a series of selectors. On each call to next(), one item is taken from both the iterable and selectors iterators. If the item from selectors evaluates to true, the item from iterable is given. Otherwise, it is skipped. Once either iterable or selectors is exhausted, subsequent calls to next() will return goog.iter.ES6_ITERATOR_DONE.

Parameters

`iterable`	`({length: number}\|{__iterator__: ?})`
	The iterable to filter.
`selectors`	`({length: number}\|{__iterator__: ?})`
	An iterable of items to be evaluated in a boolean context to determine if the corresponding element in `iterable` should be included in the result.

Returns

goog.iter.Iterator<(VALUE|null)>

A new iterator that returns the filtered values.

VIEW SOURCE

Creates an iterator that is advanced count steps ahead. Consumed values are silently discarded. If count is greater than the number of elements in iterable, an empty iterator is returned. Subsequent calls to next() will return goog.iter.ES6_ITERATOR_DONE.

Parameters

`iterable`	`({length: number}\|{__iterator__: ?})`
	The iterable to consume.
`count`	`number`
	The number of elements to consume from the iterator.

Returns

goog.iter.Iterator<(VALUE|null)>

An iterator advanced zero or more steps ahead.

VIEW SOURCE

Creates an iterator that counts indefinitely from a starting value.

Parameters

`opt_start`	`number=`
	The starting value. Default is 0.
`opt_step`	`number=`
	The number to increment with between each call to next. Negative and floating point numbers are allowed. Default is 1.

Returns

goog.iter.Iterator<number>

A new iterator that returns the values in the series.

VIEW SOURCE

Wraps a VALUE in the ES6 Iterator protocol's IIterableResult container, including the compiler-mandated 'done' key, set to false.

Parameters

`value`	`(VALUE\|null)`

Returns

IIterableResult<(VALUE|null)>

An ES6 Iteration Protocol compatible result object, indicating iteration is not done.

VIEW SOURCE

Create an iterator to cycle over the iterable's elements indefinitely. For example, ([1, 2, 3]) would return : 1, 2, 3, 1, 2, 3, ...

Parameters

`iterable`	`({length: number}\|{__iterator__: ?})`
	The iterable object.

Returns

goog.iter.Iterator<(VALUE|null)>

An iterator that iterates indefinitely over the values in iterable.

See Also

: http://docs.python.org/library/itertools.html#itertools.cycle.

VIEW SOURCE

Builds a new iterator that iterates over the original, but skips elements as long as a supplied function returns true.

Parameters

`iterable`	`({length: number}\|{__iterator__: ?}\|null)`
	The iterator object.
`f`	`function((VALUE\|null), undefined, goog.iter.Iterator<(VALUE\|null)>): boolean`
	The function to call for every value. This function takes 3 arguments (the value, undefined, and the iterator) and should return a boolean.
`opt_obj`	`(THIS\|null)=`
	The object to be used as the value of 'this' within `f`.

Returns

goog.iter.Iterator<(VALUE|null)>

A new iterator that drops elements from the original iterator as long as f is true.

VIEW SOURCE

Creates an iterator that returns arrays containing a count and an element obtained from the given iterable.

Parameters

`iterable`	`({length: number}\|{__iterator__: ?})`
	The iterable to enumerate.
`opt_start`	`number=`
	Optional starting value. Default is 0.

Returns

goog.iter.Iterator<Array<?>>

A new iterator containing count/item pairs.

VIEW SOURCE

Iterates over two iterables and returns true if they contain the same sequence of elements and have the same length.

Parameters

`iterable1`	`({length: number}\|{__iterator__: ?})`
	The first iterable object.
`iterable2`	`({length: number}\|{__iterator__: ?})`
	The second iterable object.
`opt_equalsFn`	`function((VALUE\|null), (VALUE\|null)): boolean=`
	Optional comparison function. Should take two arguments to compare, and return true if the arguments are equal. Defaults to `goog.array.defaultCompareEquality` which compares the elements using the built-in '===' operator.

Returns

boolean

true if the iterables contain the same sequence of elements and have the same length.

VIEW SOURCE

Goes through the values in the iterator. Calls f for each of these and if any of them returns false this returns false (without checking the rest). If all return true this will return true.

Parameters

`iterable`	`({length: number}\|{__iterator__: ?}\|null)`
	The iterator object.
`f`	`function((VALUE\|null), undefined, goog.iter.Iterator<(VALUE\|null)>): boolean`
	The function to call for every value. This function takes 3 arguments (the value, undefined, and the iterator) and should return a boolean.
`opt_obj`	`(THIS\|null)=`
	The object to be used as the value of 'this' within `f`.

Returns

boolean

true if every value passes the test.

VIEW SOURCE

Calls a function for every element in the iterator, and if the function returns true adds the element to a new iterator.

Parameters

`iterable`	`({length: number}\|{__iterator__: ?}\|null)`
	The iterator to iterate over.
`f`	`function((VALUE\|null), undefined, goog.iter.Iterator<(VALUE\|null)>): boolean`
	The function to call for every element. This function takes 3 arguments (the element, undefined, and the iterator) and should return a boolean. If the return value is true the element will be included in the returned iterator. If it is false the element is not included.
`opt_obj`	`(THIS\|null)=`
	The object to be used as the value of 'this' within `f`.

Returns

goog.iter.Iterator<(VALUE|null)>

A new iterator in which only elements that passed the test are present.

VIEW SOURCE

Calls a function for every element in the iterator, and if the function returns false adds the element to a new iterator.

Parameters

`iterable`	`({length: number}\|{__iterator__: ?}\|null)`
	The iterator to iterate over.
`f`	`function((VALUE\|null), undefined, goog.iter.Iterator<(VALUE\|null)>): boolean`
	The function to call for every element. This function takes 3 arguments (the element, undefined, and the iterator) and should return a boolean. If the return value is false the element will be included in the returned iterator. If it is true the element is not included.
`opt_obj`	`(THIS\|null)=`
	The object to be used as the value of 'this' within `f`.

Returns

goog.iter.Iterator<(VALUE|null)>

A new iterator in which only elements that did not pass the test are present.

VIEW SOURCE

Calls a function for each element in the iterator with the element of the iterator passed as argument.

Parameters

`iterable`	`({length: number}\|{__iterator__: ?}\|null)`
	The iterator to iterate over. If the iterable is an object `toIterator` will be called on it.
`f`	`function((VALUE\|null), ?, goog.iter.Iterator<(VALUE\|null)>): ?`
	The function to call for every element. This function takes 3 arguments (the element, undefined, and the iterator) and the return value is irrelevant. The reason for passing undefined as the second argument is so that the same function can be used in goog.array.forEach as well as others. The third parameter is of type "number" for arraylike objects, undefined, otherwise.
`opt_obj`	`(THIS\|null)=`
	The object to be used as the value of 'this' within `f`.

VIEW SOURCE

Creates an iterator that returns arrays containing elements from the iterable grouped by a key value. For iterables with repeated elements (i.e. sorted according to a particular key function), this function has a uniq-like effect. For example, grouping the array: [A, B, B, C, C, A] produces [A, [A]], [B, [B, B]], [C, [C, C]], [A, [A]].

Parameters

`iterable`	`({length: number}\|{__iterator__: ?})`
	The iterable to group.
`opt_keyFunc`	`function((VALUE\|null)): (KEY\|null)=`
	Optional function for determining the key value for each group in the `iterable`. Default is the identity function.

Returns

goog.iter.Iterator<Array<?>>

A new iterator that returns arrays of consecutive key and groups.

VIEW SOURCE

Joins the values in a iterator with a delimiter.

Parameters

`iterable`	`({length: number}\|{__iterator__: ?}\|null)`
	The iterator to get the values from.
`deliminator`	`string`
	The text to put between the values.

Returns

string

The joined value string.

VIEW SOURCE

Creates an iterator that returns the first limitSize elements from an iterable. If this number is greater than the number of elements in the iterable, all the elements are returned.

Parameters

`iterable`	`({length: number}\|{__iterator__: ?})`
	The iterable to limit.
`limitSize`	`number`
	The maximum number of elements to return.

Returns

goog.iter.Iterator<(VALUE|null)>

A new iterator containing limitSize elements.

See Also

<http://goo.gl/V0sihp Inspired by the limit iterator in Guava.>

VIEW SOURCE

For every element in the iterator call a function and return a new iterator with that value.

Parameters

`iterable`	`({length: number}\|{__iterator__: ?})`
	The iterator to iterate over.
`f`	`function((VALUE\|null), undefined, goog.iter.Iterator<(VALUE\|null)>): (RESULT\|null)`
	The function to call for every element. This function takes 3 arguments (the element, undefined, and the iterator) and should return a new value.
`opt_obj`	`(THIS\|null)=`
	The object to be used as the value of 'this' within `f`.

Returns

goog.iter.Iterator<(RESULT|null)>

A new iterator that returns the results of applying the function to each element in the original iterator.

VIEW SOURCE

Advances the iterator to the next position, returning the given default value instead of throwing an exception if the iterator has no more entries.

Parameters

`iterable`	`({length: number}\|{__iterator__: ?}\|null)`
	The iterable object.
`defaultValue`	`(VALUE\|null)`
	The value to return if the iterator is empty.

Returns

VALUE

The next item in the iteration, or defaultValue if the iterator was empty.

VIEW SOURCE

Creates an iterator that returns permutations of elements in iterable.

Permutations are obtained by taking the Cartesian product of opt_length iterables and filtering out those with repeated elements. For example, the permutations of [1,2,3] are [[1,2,3], [1,3,2], [2,1,3], [2,3,1], [3,1,2], [3,2,1]].

Parameters

`iterable`	`({length: number}\|{__iterator__: ?})`
	The iterable from which to generate permutations.
`opt_length`	`number=`
	Length of each permutation. If omitted, defaults to the length of `iterable`.

Returns

goog.iter.Iterator<Array<(VALUE|null)>>

A new iterator containing the permutations of iterable.

VIEW SOURCE

Cartesian product of zero or more sets. Gives an iterator that gives every combination of one element chosen from each set. For example, ([1, 2], [3, 4]) gives ([1, 3], [1, 4], [2, 3], [2, 4]).

Parameters

`var_args`	`...IArrayLike<(VALUE\|null)>`
	Zero or more sets, as arrays.

Returns

goog.iter.Iterator<Array<(VALUE|null)>>

An iterator that gives each n-tuple (as an array).

VIEW SOURCE

Creates a new iterator that returns the values in a range. This function can take 1, 2 or 3 arguments:

 range(5) same as range(0, 5, 1)
 range(2, 5) same as range(2, 5, 1)

Parameters

`startOrStop`	`number`
	The stop value if only one argument is provided. The start value if 2 or more arguments are provided. If only one argument is used the start value is 0.
`opt_stop`	`number=`
	The stop value. If left out then the first argument is used as the stop value.
`opt_step`	`number=`
	The number to increment with between each call to next. This can be negative.

Returns

goog.iter.Iterator<number>

A new iterator that returns the values in the range.

VIEW SOURCE

Passes every element of an iterator into a function and accumulates the result.

Parameters

`iterable`	`({length: number}\|{__iterator__: ?})`
	The iterator to iterate over.
`f`	`function((RVALUE\|null), (VALUE\|null)): (RVALUE\|null)`
	The function to call for every element. This function takes 2 arguments (the function's previous result or the initial value, and the value of the current element). function(previousValue, currentElement) : newValue.
`val`	`(RVALUE\|null)`
	The initial value to pass into the function on the first call.
`opt_obj`	`(THIS\|null)=`
	The object to be used as the value of 'this' within f.

Returns

RVALUE

Result of evaluating f repeatedly across the values of the iterator.

VIEW SOURCE

Creates an iterator that returns the same object or value repeatedly.

Parameters

`value`	`(VALUE\|null)`
	Any object or value to repeat.

Returns

goog.iter.Iterator<(VALUE|null)>

A new iterator that returns the repeated value.

VIEW SOURCE

Creates an iterator that returns a range of elements from an iterable. Similar to goog.array.slice but does not support negative indexes.

Parameters

`iterable`	`({length: number}\|{__iterator__: ?})`
	The iterable to slice.
`start`	`number`
	The index of the first element to return.
`opt_end`	`number=`
	The index after the last element to return. If defined, must be greater than or equal to `start`.

Returns

goog.iter.Iterator<(VALUE|null)>

A new iterator containing a slice of the original.

VIEW SOURCE

Goes through the values in the iterator. Calls f for each of these, and if any of them returns true, this returns true (without checking the rest). If all return false this will return false.

Parameters

`iterable`	`({length: number}\|{__iterator__: ?}\|null)`
	The iterator object.
`f`	`function((VALUE\|null), undefined, goog.iter.Iterator<(VALUE\|null)>): boolean`
	The function to call for every value. This function takes 3 arguments (the value, undefined, and the iterator) and should return a boolean.
`opt_obj`	`(THIS\|null)=`
	The object to be used as the value of 'this' within `f`.

Returns

boolean

true if any value passes the test.

VIEW SOURCE

Gives an iterator that gives the result of calling the given function f with the arguments taken from the next element from iterable (the elements are expected to also be iterables).

Similar to goog.iter.map but allows the function to accept multiple arguments from the iterable.

Parameters

`iterable`	`({length: number}\|{__iterator__: ?})`
	The iterable of iterables to iterate over.
`f`	`function(...*): (RESULT\|null)`
	The function to call for every element. This function takes N+2 arguments, where N represents the number of items from the next element of the iterable. The two additional arguments passed to the function are undefined and the iterator itself. The function should return a new value.
`opt_obj`	`(THIS\|null)=`
	The object to be used as the value of 'this' within `f`.

Returns

goog.iter.Iterator<(RESULT|null)>

A new iterator that returns the results of applying the function to each element in the original iterator.

VIEW SOURCE

Builds a new iterator that iterates over the original, but only as long as a supplied function returns true.

Parameters

`iterable`	`({length: number}\|{__iterator__: ?}\|null)`
	The iterator object.
`f`	`function((VALUE\|null), undefined, goog.iter.Iterator<(VALUE\|null)>): boolean`
	The function to call for every value. This function takes 3 arguments (the value, undefined, and the iterator) and should return a boolean.
`opt_obj`	`(THIS\|null)=`
	This is used as the 'this' object in f when called.

Returns

goog.iter.Iterator<(VALUE|null)>

A new iterator that keeps elements in the original iterator as long as the function is true.

VIEW SOURCE

Returns an array of iterators each of which can iterate over the values in iterable without advancing the others.

Parameters

`iterable`	`({length: number}\|{__iterator__: ?})`
	The iterable to tee.
`opt_num`	`number=`
	The number of iterators to create. Default is 2.

Returns

Array<(goog.iter.Iterator<(VALUE|null)>|null)>

An array of iterators.

VIEW SOURCE

Converts the iterator to an array

Parameters

`iterable`	`({length: number}\|{__iterator__: ?}\|null)`
	The iterator to convert to an array.

Returns

Array<(VALUE|null)>

An array of the elements the iterator iterates over.

VIEW SOURCE

Returns an iterator that knows how to iterate over the values in the object.

Parameters

`iterable`	`({length: number}\|{__iterator__: ?}\|null)`
	If the object is an iterator it will be returned as is. If the object has an `__iterator__` method that will be called to get the value iterator. If the object is an array-like object we create an iterator for that.

Returns

goog.iter.Iterator<(VALUE|null)>

An iterator that knows how to iterate over the values in iterable.

VIEW SOURCE

Creates an iterator that returns arrays containing the ith elements from the provided iterables. The returned arrays will be the same size as the number of iterables given in var_args. Once the shortest iterable is exhausted, subsequent calls to next() will return goog.iter.ES6_ITERATOR_DONE.

Parameters

`var_args`	`...({length: number}\|{__iterator__: ?})`
	Any number of iterable objects.

Returns

goog.iter.Iterator<Array<(VALUE|null)>>

A new iterator that returns arrays of elements from the provided iterables.

VIEW SOURCE

Creates an iterator that returns arrays containing the ith elements from the provided iterables. The returned arrays will be the same size as the number of iterables given in var_args. Shorter iterables will be extended with fillValue. Once the longest iterable is exhausted, subsequent calls to next() will return goog.iter.ES6_ITERATOR_DONE.

Parameters

`fillValue`	`(VALUE\|null)`
	The object or value used to fill shorter iterables.
`var_args`	`...({length: number}\|{__iterator__: ?})`
	Any number of iterable objects.

Returns

goog.iter.Iterator<Array<(VALUE|null)>>

A new iterator that returns arrays of elements from the provided iterables.

VIEW SOURCE

goog.iter

Functions

accumulate( iterable ) → goog.iter.Iterator<number>

chain<VALUE>( ...var_args ) → goog.iter.Iterator<(VALUE|null)>

chainFromIterable<VALUE>( iterable ) → goog.iter.Iterator<(VALUE|null)>

combinations<VALUE>( iterable, length ) → goog.iter.Iterator<Array<(VALUE|null)>>

combinationsWithReplacement<VALUE>( iterable, length ) → goog.iter.Iterator<Array<(VALUE|null)>>

compress<VALUE>( iterable, selectors ) → goog.iter.Iterator<(VALUE|null)>

consume<VALUE>( iterable, count ) → goog.iter.Iterator<(VALUE|null)>

count( opt_start, opt_step ) → goog.iter.Iterator<number>

createEs6IteratorYield<VALUE>( value ) → IIterableResult<(VALUE|null)>

cycle<VALUE>( iterable ) → goog.iter.Iterator<(VALUE|null)>

dropWhile<THIS, VALUE>( iterable, f, opt_obj ) → goog.iter.Iterator<(VALUE|null)>

enumerate<VALUE>( iterable, opt_start ) → goog.iter.Iterator<Array<?>>

equals<VALUE>( iterable1, iterable2, opt_equalsFn ) → boolean

every<THIS, VALUE>( iterable, f, opt_obj ) → boolean

filter<THIS, VALUE>( iterable, f, opt_obj ) → goog.iter.Iterator<(VALUE|null)>

filterFalse<THIS, VALUE>( iterable, f, opt_obj ) → goog.iter.Iterator<(VALUE|null)>

forEach<THIS, VALUE>( iterable, f, opt_obj ) → void

groupBy<KEY, VALUE>( iterable, opt_keyFunc ) → goog.iter.Iterator<Array<?>>

join<VALUE>( iterable, deliminator ) → string

limit<VALUE>( iterable, limitSize ) → goog.iter.Iterator<(VALUE|null)>

map<THIS, VALUE, RESULT>( iterable, f, opt_obj ) → goog.iter.Iterator<(RESULT|null)>

nextOrValue<VALUE>( iterable, defaultValue ) → VALUE

permutations<VALUE>( iterable, opt_length ) → goog.iter.Iterator<Array<(VALUE|null)>>

product<VALUE>( ...var_args ) → goog.iter.Iterator<Array<(VALUE|null)>>

range( startOrStop, opt_stop, opt_step ) → goog.iter.Iterator<number>

reduce<THIS, VALUE, RVALUE>( iterable, f, val, opt_obj ) → RVALUE

repeat<VALUE>( value ) → goog.iter.Iterator<(VALUE|null)>

slice<VALUE>( iterable, start, opt_end ) → goog.iter.Iterator<(VALUE|null)>

some<THIS, VALUE>( iterable, f, opt_obj ) → boolean

starMap<THIS, RESULT>( iterable, f, opt_obj ) → goog.iter.Iterator<(RESULT|null)>

takeWhile<THIS, VALUE>( iterable, f, opt_obj ) → goog.iter.Iterator<(VALUE|null)>

tee<VALUE>( iterable, opt_num ) → Array<(goog.iter.Iterator<(VALUE|null)>|null)>

toArray<VALUE>( iterable ) → Array<(VALUE|null)>

toIterator<VALUE>( iterable ) → goog.iter.Iterator<(VALUE|null)>

zip<VALUE>( ...var_args ) → goog.iter.Iterator<Array<(VALUE|null)>>

zipLongest<VALUE>( fillValue, ...var_args ) → goog.iter.Iterator<Array<(VALUE|null)>>

Properties

ES6_ITERATOR_DONE → IIterableResult<?>

Iterable → ({length: number}|{__iterator__: ?})

Classes

accumulate( `iterable` ) `→` `goog.iter.Iterator<number>`

chain`<VALUE>`( `...var_args` ) `→` `goog.iter.Iterator<(VALUE|null)>`

chainFromIterable`<VALUE>`( `iterable` ) `→` `goog.iter.Iterator<(VALUE|null)>`

combinations`<VALUE>`( `iterable`, `length` ) `→` `goog.iter.Iterator<Array<(VALUE|null)>>`

combinationsWithReplacement`<VALUE>`( `iterable`, `length` ) `→` `goog.iter.Iterator<Array<(VALUE|null)>>`

compress`<VALUE>`( `iterable`, `selectors` ) `→` `goog.iter.Iterator<(VALUE|null)>`

consume`<VALUE>`( `iterable`, `count` ) `→` `goog.iter.Iterator<(VALUE|null)>`

count( `opt_start`, `opt_step` ) `→` `goog.iter.Iterator<number>`

createEs6IteratorYield`<VALUE>`( `value` ) `→` `IIterableResult<(VALUE|null)>`

cycle`<VALUE>`( `iterable` ) `→` `goog.iter.Iterator<(VALUE|null)>`

dropWhile`<THIS, VALUE>`( `iterable`, `f`, `opt_obj` ) `→` `goog.iter.Iterator<(VALUE|null)>`

enumerate`<VALUE>`( `iterable`, `opt_start` ) `→` `goog.iter.Iterator<Array<?>>`

equals`<VALUE>`( `iterable1`, `iterable2`, `opt_equalsFn` ) `→` `boolean`

every`<THIS, VALUE>`( `iterable`, `f`, `opt_obj` ) `→` `boolean`

filter`<THIS, VALUE>`( `iterable`, `f`, `opt_obj` ) `→` `goog.iter.Iterator<(VALUE|null)>`

filterFalse`<THIS, VALUE>`( `iterable`, `f`, `opt_obj` ) `→` `goog.iter.Iterator<(VALUE|null)>`

forEach`<THIS, VALUE>`( `iterable`, `f`, `opt_obj` ) `→` `void`

groupBy`<KEY, VALUE>`( `iterable`, `opt_keyFunc` ) `→` `goog.iter.Iterator<Array<?>>`

join`<VALUE>`( `iterable`, `deliminator` ) `→` `string`

limit`<VALUE>`( `iterable`, `limitSize` ) `→` `goog.iter.Iterator<(VALUE|null)>`

map`<THIS, VALUE, RESULT>`( `iterable`, `f`, `opt_obj` ) `→` `goog.iter.Iterator<(RESULT|null)>`

nextOrValue`<VALUE>`( `iterable`, `defaultValue` ) `→` `VALUE`

permutations`<VALUE>`( `iterable`, `opt_length` ) `→` `goog.iter.Iterator<Array<(VALUE|null)>>`

product`<VALUE>`( `...var_args` ) `→` `goog.iter.Iterator<Array<(VALUE|null)>>`

range( `startOrStop`, `opt_stop`, `opt_step` ) `→` `goog.iter.Iterator<number>`

reduce`<THIS, VALUE, RVALUE>`( `iterable`, `f`, `val`, `opt_obj` ) `→` `RVALUE`

repeat`<VALUE>`( `value` ) `→` `goog.iter.Iterator<(VALUE|null)>`

slice`<VALUE>`( `iterable`, `start`, `opt_end` ) `→` `goog.iter.Iterator<(VALUE|null)>`

some`<THIS, VALUE>`( `iterable`, `f`, `opt_obj` ) `→` `boolean`

starMap`<THIS, RESULT>`( `iterable`, `f`, `opt_obj` ) `→` `goog.iter.Iterator<(RESULT|null)>`

takeWhile`<THIS, VALUE>`( `iterable`, `f`, `opt_obj` ) `→` `goog.iter.Iterator<(VALUE|null)>`

tee`<VALUE>`( `iterable`, `opt_num` ) `→` `Array<(goog.iter.Iterator<(VALUE|null)>|null)>`

toArray`<VALUE>`( `iterable` ) `→` `Array<(VALUE|null)>`

toIterator`<VALUE>`( `iterable` ) `→` `goog.iter.Iterator<(VALUE|null)>`

zip`<VALUE>`( `...var_args` ) `→` `goog.iter.Iterator<Array<(VALUE|null)>>`

zipLongest`<VALUE>`( `fillValue`, `...var_args` ) `→` `goog.iter.Iterator<Array<(VALUE|null)>>`

ES6_ITERATOR_DONE `→` `IIterableResult<?>`

Iterable `→` `({length: number}|{iterator: ?})`