X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FPoolEmitter.html;h=281c8fc2f05c0f65f333f37a73fd91ab8b9f4007;hb=341ec6db3b66173fd9314338b736fabb0639914b;hp=33034a59d7aa2c38b1cad4c6e06045bfb652e75c;hpb=6b83e544b1827a8a04898c3032dab73fe19687e6;p=poolifier.git diff --git a/docs/classes/PoolEmitter.html b/docs/classes/PoolEmitter.html index 33034a59..281c8fc2 100644 --- a/docs/classes/PoolEmitter.html +++ b/docs/classes/PoolEmitter.html @@ -1,4 +1,4 @@ -PoolEmitter | poolifier - v2.6.23
+PoolEmitter | poolifier - v2.6.40
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.23
+
  • The search index is not available
  • poolifier - v2.6.40
    @@ -26,7 +26,7 @@
    • PoolEmitter
    +
  • Defined in src/pools/pool.ts:39
  • @@ -60,6 +60,7 @@ removeAllListeners removeListener setMaxListeners +addAbortListener getEventListeners getMaxListeners listenerCount @@ -78,11 +79,11 @@

    Parameters

    • -
      Optional options: EventEmitterOptions
    +
    Optional options: EventEmitterOptions
    Optional

    Returns PoolEmitter

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:109
  • Properties

    @@ -96,7 +97,7 @@
    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:390
  • captureRejections: boolean
    @@ -108,7 +109,7 @@
    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:397
  • defaultMaxListeners: number
    @@ -139,7 +140,7 @@ Its name property is set to 'MaxListenersExceededWarning&
    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:434
  • errorMonitor: typeof errorMonitor
    @@ -152,7 +153,7 @@ regular 'error' listener is installed.

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:383
  • Methods

    @@ -178,7 +179,7 @@ regular 'error' listener is installed.

    Parameters

    • -
      Rest ...args: any[]
    +
    Rest ...args: any[]
    Rest

    Returns void

    Returns PoolEmitter

    @@ -186,7 +187,7 @@ regular 'error' listener is installed.

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:454
    • @@ -204,14 +205,14 @@ to each.

    • eventName: string | symbol
    • -
      Rest ...args: any[]
    +
    Rest ...args: any[]
    Rest

    Returns boolean

    Since

    v0.1.26

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:716
    • @@ -228,7 +229,7 @@ listeners. The values in the array are strings or Symbols.

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:779
  • +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:631
    • @@ -259,20 +260,18 @@ in the list of the listeners of the event.

    • eventName: string | symbol

      The name of the event being listened for

      -
      -
    • +
    • Optional listener: Function

      The event handler function

      -
      -
    +Optional

    Returns number

    Since

    v3.2.0

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:725
    • @@ -293,7 +292,7 @@ in the list of the listeners of the event.

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:644
    • @@ -317,7 +316,7 @@ in the list of the listeners of the event.

      Parameters

      • -
        Rest ...args: any[]
      +
      Rest ...args: any[]
      Rest

    Returns void

    Returns PoolEmitter

    @@ -325,7 +324,7 @@ in the list of the listeners of the event.

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:604
    • @@ -349,13 +348,11 @@ event listener to the beginning of the listeners array.

    • eventName: string | symbol

      The name of the event.

      -
      -
    • +
    • listener: ((...args) => void)

      The callback function

      -
        • @@ -365,7 +362,7 @@ event listener to the beginning of the listeners array.

          Parameters

          • -
            Rest ...args: any[]
          +
          Rest ...args: any[]
          Rest

        Returns void

    Returns PoolEmitter

    @@ -373,7 +370,7 @@ event listener to the beginning of the listeners array.

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:486
    • @@ -395,13 +392,11 @@ event listener to the beginning of the listeners array.

    • eventName: string | symbol

      The name of the event.

      -
      -
    • +
    • listener: ((...args) => void)

      The callback function

      -
        • @@ -411,7 +406,7 @@ event listener to the beginning of the listeners array.

          Parameters

          • -
            Rest ...args: any[]
          +
          Rest ...args: any[]
          Rest

        Returns void

    Returns PoolEmitter

    @@ -419,7 +414,7 @@ event listener to the beginning of the listeners array.

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:516
    • @@ -439,13 +434,11 @@ times.

    • eventName: string | symbol

      The name of the event.

      -
      -
    • +
    • listener: ((...args) => void)

      The callback function

      -
        • @@ -455,7 +448,7 @@ times.

          Parameters

          • -
            Rest ...args: any[]
          +
          Rest ...args: any[]
          Rest

        Returns void

    Returns PoolEmitter

    @@ -463,7 +456,7 @@ times.

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:743
    • @@ -481,13 +474,11 @@ listener is removed, and then invoked.

    • eventName: string | symbol

      The name of the event.

      -
      -
    • +
    • listener: ((...args) => void)

      The callback function

      -
        • @@ -497,7 +488,7 @@ listener is removed, and then invoked.

          Parameters

          • -
            Rest ...args: any[]
          +
          Rest ...args: any[]
          Rest

        Returns void

    Returns PoolEmitter

    @@ -505,7 +496,7 @@ listener is removed, and then invoked.

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:759
    • @@ -527,7 +518,7 @@ including any wrappers (such as those created by .once()).

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:675
    • @@ -543,14 +534,14 @@ component or module (e.g. sockets or file streams).

      Parameters

      • -
        Optional event: string | symbol
      +
      Optional event: string | symbol
      Optional

    Returns PoolEmitter

    Since

    v0.1.26

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:615
    • @@ -596,7 +587,7 @@ recently added instance. In the example the once('ping')lis

      Parameters

      • -
        Rest ...args: any[]
      +
      Rest ...args: any[]
      Rest

    Returns void

    Returns PoolEmitter

    @@ -604,7 +595,7 @@ recently added instance. In the example the once('ping')lis
    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:599
    • @@ -627,7 +618,51 @@ modified for this specific EventEmitter instance. The value can be
    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:625
  • +
    + +
      + +
    • Experimental +

      Listens once to the abort event on the provided signal.

      +

      Listening to the abort event on abort signals is unsafe and may +lead to resource leaks since another third party with the signal can +call e.stopImmediatePropagation(). Unfortunately Node.js cannot change +this since it would violate the web standard. Additionally, the original +API makes it easy to forget to remove listeners.

      +

      This API allows safely using AbortSignals in Node.js APIs by solving these +two issues by listening to the event such that stopImmediatePropagation does +not prevent the listener from running.

      +

      Returns a disposable so that it may be unsubscribed from more easily.

      +
      import { addAbortListener } from 'node:events';

      function example(signal) {
      let disposable;
      try {
      signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
      disposable = addAbortListener(signal, (e) => {
      // Do something when signal is aborted.
      });
      } finally {
      disposable?.[Symbol.dispose]();
      }
      } +
      +
      +
      +

      Parameters

      +
        +
      • +
        signal: AbortSignal
      • +
      • +
        resource: ((event) => void)
        +
          +
        • +
            +
          • (event): void
          • +
          • +
            +

            Parameters

            +
              +
            • +
              event: Event
            +

            Returns void

      +

      Returns Disposable

      that removes the abort listener.

      + +
      +

      Since

      v20.5.0

      +
      @@ -654,7 +689,7 @@ event target. This is useful for debugging and diagnostic purposes.

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:296
    • @@ -680,7 +715,7 @@ the max set, the EventTarget will print a warning.

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:325
    • @@ -696,13 +731,11 @@ the max set, the EventTarget will print a warning.

    • emitter: EventEmitter

      The emitter to query

      -
      -
    • +
    • eventName: string | symbol

      The event name

      -
      -
    +

    Returns number

    Since

    v0.9.12

    @@ -711,7 +744,7 @@ the max set, the EventTarget will print a warning.

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:268
    • @@ -735,10 +768,9 @@ composed of the emitted event arguments.

    • eventName: string

      The name of the event being listened for

      -
      -
    • +
    • -
      Optional options: StaticEventEmitterOptions
    +
    Optional options: StaticEventEmitterOptions
    Optional

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

    @@ -746,7 +778,7 @@ composed of the emitted event arguments.

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:250
    • @@ -777,14 +809,14 @@ special handling:

    • eventName: string | symbol
    • -
      Optional options: StaticEventEmitterOptions
    +
    Optional options: StaticEventEmitterOptions
    Optional

    Returns Promise<any[]>

    Since

    v11.13.0, v10.16.0

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:189
  • @@ -795,11 +827,11 @@ special handling:

  • eventName: string
  • -
    Optional options: StaticEventEmitterOptions
  • +
    Optional options: StaticEventEmitterOptions
    Optional

    Returns Promise<any[]>

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:190
    • @@ -814,17 +846,16 @@ special handling:

    • Optional n: number

      A non-negative number. The maximum number of listeners per EventTarget event.

      -
      -
    • +Optional
    • -
      Rest ...eventTargets: (EventEmitter | _DOMEventTarget)[]
    +
    Rest ...eventTargets: (EventEmitter | _DOMEventTarget)[]
    Rest

    Returns void

    Since

    v15.4.0

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/events.d.ts:340
  • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file