Class AsyncGeneratorWithSetup<S, T, TReturn, TNext>

constructor

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

  Type Parameters

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

  Parameters

  • params: {
        config?: unknown;
        generator: AsyncGenerator<T>;
        signal?: AbortSignal;
        startSetup?: () => 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: [] | [TNext]): Promise<IteratorResult<T, any>>

  Parameters

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

  Returns Promise<IteratorResult<T, any>>

return

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

  Parameters

  • Optionalvalue: TReturn | PromiseLike<TReturn>

  Returns Promise<IteratorResult<T, any>>

throw

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

  Parameters

  • e: Error

  Returns Promise<IteratorResult<T, any>>