Interface AsyncGenerator<T, TReturn, TNext>

Type parameters

T = unknown
TReturn = any
TNext = unknown

Hierarchy-Diagram

UML class diagram of AsyncGenerator

Legend

icon for an interface in the UML class diagram

interface

icon for a public method in the UML class diagram

public method

Hierarchy

AsyncIterator<T, TReturn, TNext>
- AsyncGenerator

Index

Methods

Methods

[asyncIterator]

[asyncIterator](): AsyncGenerator<T, TReturn, TNext>

- Defined in node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts:28
Returns AsyncGenerator<T, TReturn, TNext>

next

next(...args: [] | [TNext]): Promise<IteratorResult<T, TReturn>>

Overrides AsyncIterator.next
- Defined in node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts:25
Parameters
- Rest ...args: [] | [TNext]
Returns Promise<IteratorResult<T, TReturn>>

return

return(value: TReturn | PromiseLike<TReturn>): Promise<IteratorResult<T, TReturn>>

Overrides AsyncIterator.return
- Defined in node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts:26
Parameters
- value: TReturn | PromiseLike<TReturn>
Returns Promise<IteratorResult<T, TReturn>>

throw

throw(e: any): Promise<IteratorResult<T, TReturn>>

Overrides AsyncIterator.throw
- Defined in node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts:27
Parameters
- e: any
Returns Promise<IteratorResult<T, TReturn>>

Generated using TypeDoc