Interface AsyncIterator<T, TReturn, TNext>

interface AsyncIterator {
    next(...args): Promise<IteratorResult<T, TReturn>>;
    return?(value?): Promise<IteratorResult<T, TReturn>>;
    throw?(e?): Promise<IteratorResult<T, TReturn>>;
}

Type Parameters

  • T

  • TReturn = any

  • TNext = undefined

Methods

next return? throw?

Methods

next

  • next(...args): Promise<IteratorResult<T, TReturn>>

  • Parameters

    • Rest ...args: [] | [TNext]

    Returns Promise<IteratorResult<T, TReturn>>

Optional return

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

  • Parameters

    Returns Promise<IteratorResult<T, TReturn>>

Optional throw

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

  • Parameters

    • Optional e: any

    Returns Promise<IteratorResult<T, TReturn>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc