Skip to main content

AsyncIteratorObject

Describes an AsyncIterator produced by the runtime that inherits from the intrinsic AsyncIterator.prototype.

Extends​

Extended by​

Type Parameters​

Type ParameterDefault type
T-
TReturnunknown
TNextunknown

Methods​

[asyncIterator]()​

asyncIterator: AsyncIteratorObject<T, TReturn, TNext>;

Returns​

AsyncIteratorObject<T, TReturn, TNext>


next()​

next(...__namedParameters): Promise<IteratorResult<T, TReturn>>;

Parameters​

ParameterType
...__namedParameters[] | [TNext]

Returns​

Promise<IteratorResult<T, TReturn>>

Inherited from​

AsyncIterator.next


return()?​

optional return(value?): Promise<IteratorResult<T, TReturn>>;

Parameters​

ParameterType
value?TReturn | PromiseLike<TReturn>

Returns​

Promise<IteratorResult<T, TReturn>>

Inherited from​

AsyncIterator.return


throw()?​

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

Parameters​

ParameterType
e?any

Returns​

Promise<IteratorResult<T, TReturn>>

Inherited from​

AsyncIterator.throw