Github Link
      ⚠️ Internal: This API is not publically exported by the package.

      Interface StaticEventEmitterIteratorOptions

      interface StaticEventEmitterIteratorOptions {
          close?: string[];
          highWaterMark?: number;
          lowWaterMark?: number;
          signal?: AbortSignal;
      }

      Hierarchy

      Properties

      close? highWaterMark? lowWaterMark? signal?

      Properties

      Optional close

      close?: string[]

      Names of events that will end the iteration.

      Optional highWaterMark

      highWaterMark?: number

      The high watermark. The emitter is paused every time the size of events being buffered is higher than it. Supported only on emitters implementing pause() and resume() methods.

      Default

      Number.MAX_SAFE_INTEGER

      Optional lowWaterMark

      lowWaterMark?: number

      The low watermark. The emitter is resumed every time the size of events being buffered is lower than it. Supported only on emitters implementing pause() and resume() methods.

      Default

      1

      Optional signal

      signal?: AbortSignal

      Can be used to cancel awaiting events.

      Settings

      Member Visibility

      Theme

      On This Page