Interface IteratorObject<T, TReturn, TNext>

Describes an Iterator produced by the runtime that inherits from the intrinsic Iterator.prototype.

interface IteratorObject<T, TReturn = unknown, TNext = unknown> {
    "[iterator]"(): IteratorObject<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 = unknown
TNext = unknown

Hierarchy (View Summary, Expand)

Iterator<T, TReturn, TNext>
- IteratorObject
  - ArrayIterator

Index

Methods

[iterator]

"[iterator]"(): IteratorObject<T, TReturn, TNext>
Returns IteratorObject<T, TReturn, TNext>
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:63

next

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

`Optional`return

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

`Optional`throw

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