Interface IterableIterator<T, TReturn, TNext>

Describes a user-defined Iterator that is also iterable.

interface IterableIterator<T, TReturn, TNext> {
    [iterator](): IterableIterator<T, TReturn, TNext>;
    next(...__namedParameters): IteratorResult<T, TReturn>;
    return?(value?): IteratorResult<T, TReturn>;
    throw?(e?): IteratorResult<T, TReturn>;
}

Type Parameters

T
TReturn = any
TNext = any

Hierarchy (view full)

Iterator<T, TReturn, TNext>
- IterableIterator

Index

Methods

[iterator] next return? throw?

Methods

[iterator]

[iterator](): IterableIterator<T, TReturn, TNext>
Returns IterableIterator<T, TReturn, TNext>

next

next(...__namedParameters): IteratorResult<T, TReturn>
Parameters
- Rest ...__namedParameters: [] | [TNext]
Returns IteratorResult<T, TReturn>
Inherited from Iterator.next

`Optional` return

return(value?): IteratorResult<T, TReturn>
Parameters
- Optional value: TReturn
Returns IteratorResult<T, TReturn>
Inherited from Iterator.return

`Optional` throw

throw(e?): IteratorResult<T, TReturn>
Parameters
- Optional e: any
Returns IteratorResult<T, TReturn>
Inherited from Iterator.throw