Interface Generator<T, TReturn, TNext>

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

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

Type Parameters

T = unknown
TReturn = any
TNext = any

Hierarchy

IteratorObject<T, TReturn, TNext>
- Generator (view full)

Index

Methods

[iterator] next return throw

Methods

[iterator]

[iterator](): Generator<T, TReturn, TNext>
Returns Generator<T, TReturn, TNext>
Overrides IteratorObject.[iterator]

next

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

return

return(value): IteratorResult<T, TReturn>
Parameters
- value: TReturn
Returns IteratorResult<T, TReturn>
Overrides IteratorObject.return

throw

throw(e): IteratorResult<T, TReturn>
Parameters
- e: any
Returns IteratorResult<T, TReturn>
Overrides IteratorObject.throw