Interface AsyncIterator<T, TReturn, TNext>

interface AsyncIterator<T, TReturn, TNext> {
    next(...__namedParameters: [] | [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 = any

Hierarchy

AsyncIterator (view full)
- AsyncIterableIterator
- AsyncIteratorObject

Index

Methods

next return? throw?

Methods

next

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

`Optional`return

return(value?): Promise<IteratorResult<T, TReturn>>
Parameters
- Optionalvalue: TReturn | PromiseLike<TReturn>
Returns Promise<IteratorResult<T, TReturn>>

`Optional`throw

throw(e?): Promise<IteratorResult<T, TReturn>>
Parameters
- Optionale: any
Returns Promise<IteratorResult<T, TReturn>>