Class AsyncGeneratorWithSetup<S, T, TReturn, TNext>

constructor

• new AsyncGeneratorWithSetup<S, T, TReturn, TNext>(params): AsyncGeneratorWithSetup<S, T, TReturn, TNext>

• Type Parameters

  • S = unknown
  • T = unknown
  • TReturn = unknown
  • TNext = unknown

  Parameters

  • params: {
        config?: unknown;
        generator: AsyncGenerator<T, any, unknown>;
        signal?: AbortSignal;
        startSetup?: (() => Promise<S>);
    }

    • Optionalconfig?: unknown

    • generator: AsyncGenerator<T, any, unknown>

    • Optionalsignal?: AbortSignal

    • OptionalstartSetup?: (() => Promise<S>)

      • • (): Promise<S>

        • Returns Promise<S>

  Returns AsyncGeneratorWithSetup<S, T, TReturn, TNext>

Optionalconfig

setup

Optionalsignal

[asyncDispose]

• [asyncDispose](): Promise<void>

• Returns Promise<void>

[asyncIterator]

• [asyncIterator](): AsyncGeneratorWithSetup<S, T, TReturn, TNext>

• Returns AsyncGeneratorWithSetup<S, T, TReturn, TNext>

next

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

• Parameters

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

  Returns Promise<IteratorResult<T, any>>

return

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

• Parameters

  • Optionalvalue: TReturn | PromiseLike<TReturn>

  Returns Promise<IteratorResult<T, any>>

throw

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

• Parameters

  • e: Error

  Returns Promise<IteratorResult<T, any>>