On this page

Interface IterableIterator<T, TReturn, TNext>

Describes a user-defined Iterator that is also iterable.

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

Type Parameters

T
TReturn = any
TNext = any

Hierarchy (View Summary)

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: [] | [TNext]): IteratorResult<T, TReturn>
Parameters
- ...__namedParameters: [] | [TNext]
Returns IteratorResult<T, TReturn>
Inherited from Iterator.next

`Optional`return

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

`Optional`throw

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

Was this helpful?