Interface AsyncIterator<T, TReturn, TNext>

Type parameters

T
TReturn = any
TNext = undefined

Hierarchy-Diagram

UML class diagram of AsyncIterator

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
- AsyncGenerator
- AsyncIterableIterator

Index

Methods

Methods

next

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

- Defined in node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:34
Parameters
- Rest ...args: [] | [TNext]
Returns Promise<IteratorResult<T, TReturn>>

Optional return

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

- Defined in node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:35
Parameters
- Optional value: TReturn | PromiseLike<TReturn>
Returns Promise<IteratorResult<T, TReturn>>

Optional throw

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

- Defined in node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:36
Parameters
- Optional e: any
Returns Promise<IteratorResult<T, TReturn>>

Generated using TypeDoc