Interface AsyncIterator<T, TReturn, TNext>

interface AsyncIterator<T, TReturn, TNext> {
    next(...args: [] | [TNext]): Promise<IteratorResult<T, TReturn>>;
    return?(value?: TReturn | PromiseLike<TReturn>): Promise<IteratorResult<T, TReturn>>;
    throw?(e?: any): Promise<IteratorResult<T, TReturn>>;
}

Type Parameters

T
TReturn = any
TNext = undefined

Hierarchy (view full)

AsyncIterator
- AsyncIterableIterator
- AsyncGenerator

Index

Methods

next return? throw?

Methods

next

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

`Optional`return

return(value?): Promise<IteratorResult<T, TReturn>>
Parameters
- Optionalvalue: TReturn | PromiseLike<TReturn>
Returns Promise<IteratorResult<T, TReturn>>
- Defined in node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:33

`Optional`throw

throw(e?): Promise<IteratorResult<T, TReturn>>
Parameters
- Optionale: any
Returns Promise<IteratorResult<T, TReturn>>
- Defined in node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:34