Interface AsyncGenerator<T, TReturn, TNext>

interface AsyncGenerator<T = unknown, TReturn = any, TNext = any> {
    "[asyncDispose]"(): PromiseLike<void>;
    "[asyncDispose]"(): PromiseLike<void>;
    "[asyncIterator]"(): AsyncGenerator<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 = unknown
  • TReturn = any
  • TNext = any

Hierarchy

Methods

[asyncDispose] [asyncIterator] next return throw

Methods

[asyncDispose]

  • "[asyncDispose]"(): PromiseLike<void>

  • Returns PromiseLike<void>

  • "[asyncDispose]"(): PromiseLike<void>

  • Returns PromiseLike<void>

[asyncIterator]

next

  • next(...__namedParameters: [] | [TNext]): Promise<IteratorResult<T, TReturn>>

  • Parameters

    • ...__namedParameters: [] | [TNext]

    Returns Promise<IteratorResult<T, TReturn>>

return

throw

Settings

Member Visibility

On This Page

Methods