Interface AsyncIterableIterator<T, TReturn, TNext>

Describes a user-defined AsyncIterator that is also async iterable.

interface AsyncIterableIterator<T, TReturn = any, TNext = any> {
    "[asyncIterator]"(): AsyncIterableIterator<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 (View Summary)

Methods

[asyncIterator] next return? throw?

Methods

[asyncIterator]

next

Optionalreturn

Optionalthrow

Settings

Member Visibility

On This Page

Methods