Interface AsyncIteratorObject<T, TReturn, TNext>
interface AsyncIteratorObject<T, TReturn = unknown, TNext = unknown> {
"[asyncIterator]"(): AsyncIteratorObject<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>>;
}
"[asyncIterator]"(): AsyncIteratorObject<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
Hierarchy
- AsyncIterator<T, TReturn, TNext>
- AsyncIteratorObject (View Summary)
Index
Methods
Methods
[asyncIterator]
- "[asyncIterator]"(): AsyncIteratorObject<T, TReturn, TNext>
Returns AsyncIteratorObject<T, TReturn, TNext>
next
- next(...__namedParameters: [] | [TNext]): Promise<IteratorResult<T, TReturn>>
Parameters
- ...__namedParameters: [] | [TNext]
Returns Promise<IteratorResult<T, TReturn>>
Optionalreturn
- return(
value?: TReturn | PromiseLike<TReturn>,
): Promise<IteratorResult<T, TReturn>> Parameters
Optionalvalue: TReturn | PromiseLike<TReturn>
Returns Promise<IteratorResult<T, TReturn>>
Optionalthrow
- throw(e?: any): Promise<IteratorResult<T, TReturn>>
Parameters
Optionale: any
Returns Promise<IteratorResult<T, TReturn>>
Describes an AsyncIterator produced by the runtime that inherits from the intrinsic
AsyncIterator.prototype.