Interface IterableIterator<TValue, TReturn, TNext>

We override the default IterableIterator interface since it doesn't allow forwarding of the other 2 type params that Iterator can take

Type Parameters

TValue
TReturn = any
TNext = any

Hierarchy

Iterator<TValue, TReturn, TNext>
- IterableIterator

Implemented by

AugmentedIterator

Index

Methods

[iterator] next return? throw?

Methods

[iterator]

[iterator](): IterableIterator<TValue, TReturn, TNext>
Returns IterableIterator<TValue, TReturn, TNext>
- Defined in src/index.ts:49

next

next(...args): IteratorResult<TValue, TReturn>
Parameters
- Rest ...args: [] | [TNext]
Returns IteratorResult<TValue, TReturn>
Inherited from Iterator.next
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:43

`Optional` return

return(value?): IteratorResult<TValue, TReturn>
Parameters
- Optional value: TReturn
Returns IteratorResult<TValue, TReturn>
Inherited from Iterator.return
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:44

`Optional` throw

throw(e?): IteratorResult<TValue, TReturn>
Parameters
- Optional e: any
Returns IteratorResult<TValue, TReturn>
Inherited from Iterator.throw
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:45

Generated using TypeDoc