Interface AsyncIterator<T, TReturn, TNext>

An async iterable iterator returned by the Node.js API.

interface AsyncIterator<T, TReturn, TNext> {
    "[asyncIterator]"(): 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
  • TNext

Hierarchy

  • AsyncIterator<T, TReturn, TNext>
  • AsyncIteratorObject<T, TReturn, TNext>
    • AsyncIterator

Methods

[asyncIterator]

  • "[asyncIterator]"(): AsyncIterator<T, TReturn, TNext>

    Returns AsyncIterator<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>>

Settings

Member Visibility

On This Page

Methods
MMNEPVFCICPMFPCPTTAAATR