X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FPoolEmitter.html;h=da05fefe3f6582519f51c4cec4d19be3ab4ebfdd;hb=fbc22127e53d3ec0ecbd38ecea25fb92ebef50e7;hp=a2988aea73b31f2a81fc91513d369bdc105e550a;hpb=67a6f2fa4500ca41675aaec32730093d312a351d;p=poolifier.git diff --git a/docs/classes/PoolEmitter.html b/docs/classes/PoolEmitter.html index a2988aea..da05fefe 100644 --- a/docs/classes/PoolEmitter.html +++ b/docs/classes/PoolEmitter.html @@ -1,4 +1,4 @@ -PoolEmitter | poolifier
+PoolEmitter | poolifier
+

Returns PoolEmitter

Properties

-
+

Static Readonly captureRejectionSymbol

-
captureRejectionSymbol: typeof captureRejectionSymbol
-
+

Static captureRejections

-
captureRejections: boolean
+
captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

-
+

Static defaultMaxListeners

-
defaultMaxListeners: number
-
+

Static Readonly errorMonitor

-
errorMonitor: typeof errorMonitor
+
errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

@@ -118,10 +118,10 @@ regular 'error' listener is installed.

  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:327

    • Methods

    -
    +

    addListener

    -
      - +
        +

      • Alias for emitter.on(eventName, listener).

        @@ -131,28 +131,28 @@ regular 'error' listener is installed.

        Parameters

        • -
          eventName: string | symbol
          • +
          eventName: string | symbol
        • -
          listener: ((...args: any[]) => void)
          +
          listener: ((...args) => void)
          • -
              -
            • (...args: any[]): void
              • +
                +
              • (...args): void

              • Parameters

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

        Returns void

    -

    Returns PoolEmitter

    -
    +

    getMaxListeners

    -
    -
    +

    on

    -
      - +
        +

      • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has @@ -297,32 +297,32 @@ event listener to the beginning of the listeners array.

        Parameters

        • -
          eventName: string | symbol
          +
          eventName: string | symbol

          The name of the event.

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

          The callback function

          • -
              -
            • (...args: any[]): void
              • +
                +
              • (...args): void

              • Parameters

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

        Returns void

    -

    Returns PoolEmitter

    -
    +

    once

    -
      - +
        +

      • Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

        @@ -340,32 +340,32 @@ event listener to the beginning of the listeners array.

        Parameters

        • -
          eventName: string | symbol
          +
          eventName: string | symbol

          The name of the event.

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

          The callback function

          • -
              -
            • (...args: any[]): void
              • +
                +
              • (...args): void

              • Parameters

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

        Returns void

    -

    Returns PoolEmitter

    -
    +

    prependListener

    -
      - +
        +

      • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has @@ -381,32 +381,32 @@ times.

        Parameters

        • -
          eventName: string | symbol
          +
          eventName: string | symbol

          The name of the event.

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

          The callback function

          • -
              -
            • (...args: any[]): void
              • +
                +
              • (...args): void

              • Parameters

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

        Returns void

    -

    Returns PoolEmitter

    -
    +

    prependOnceListener

    -
      - +
        +

      • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

        @@ -420,32 +420,32 @@ listener is removed, and then invoked.

        Parameters

        • -
          eventName: string | symbol
          +
          eventName: string | symbol

          The name of the event.

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

          The callback function

          • -
              -
            • (...args: any[]): void
              • +
                +
              • (...args): void

              • Parameters

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

        Returns void

    -

    Returns PoolEmitter

    -
    +

    rawListeners

    -
      - +
        +

      • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

        @@ -458,15 +458,15 @@ including any wrappers (such as those created by .once()).

        Parameters

        • -
          eventName: string | symbol
        -

        Returns Function[]

      +

      Returns Function[]

    -
    +

    removeAllListeners

    -
      - +
        +

      • Removes all listeners, or those of the specified eventName.

        It is bad practice to remove listeners added elsewhere in the code, @@ -480,15 +480,15 @@ component or module (e.g. sockets or file streams).

        Parameters

        • -
          Optional event: string | symbol
        -

        Returns PoolEmitter

      +

      Returns PoolEmitter

    -
    +

    removeListener

    -
      - +
        +

      • Removes the specified listener from the listener array for the event namedeventName.

        const callback = (stream) => {
          console.log('someone connected!');
        };
        server.on('connection', callback);
        // ...
        server.removeListener('connection', callback);
@@ -520,28 +520,28 @@ recently added instance. In the example the once('ping')lis
 
        Parameters
        
 
          
 
        • 
-
          eventName: string | symbol
          • 
+
          eventName: string | symbol
          
 
        • 
-
          listener: ((...args: any[]) => void)
          
+
          listener: ((...args) => void)
          
 
            
 
          • 
-
              
-
            • (...args: any[]): void
              • 
+
                
+
              • (...args): void
                • 
 
              • 
 
                
 
                Parameters
                
 
                  
 
                • 
-
                  Rest ...args: any[]
                
+
                Rest ...args: any[]

        Returns void

    -

    Returns PoolEmitter

    -
    +

    setMaxListeners

    -
      - +
        +

      • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding @@ -555,15 +555,15 @@ modified for this specific EventEmitter instance. The value can be

        Parameters

        • -
          n: number
        -

        Returns PoolEmitter

      +

      Returns PoolEmitter

    -
    +

    Static getEventListeners

    -
      - +
        +

      • Returns a copy of the array of listeners for the event named eventName.

        For EventEmitters this behaves exactly the same as calling .listeners on @@ -579,17 +579,17 @@ event target. This is useful for debugging and diagnostic purposes.

        Parameters

        • -
          emitter: EventEmitter | _DOMEventTarget
          • +
          emitter: EventEmitter | _DOMEventTarget
        • -
          name: string | symbol
        -

        Returns Function[]

      +

      Returns Function[]

    -
    +

    Static listenerCount

    -
      - +
        +

      • A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

        const { EventEmitter, listenerCount } = require('events');
        const myEmitter = new EventEmitter();
        myEmitter.on('event', () => {});
        myEmitter.on('event', () => {});
        console.log(listenerCount(myEmitter, 'event'));
        // Prints: 2
@@ -603,21 +603,21 @@ event target. This is useful for debugging and diagnostic purposes.
        
 
        Parameters
        
 
          
 
        • 
-
          emitter: EventEmitter
          
+
          emitter: EventEmitter
          
 
          The emitter to query
          
 
          • 
 
        • 
-
          eventName: string | symbol
          
+
          eventName: string | symbol
          
 
          The event name

        Returns number

    -
    +

    Static on

    -
      - +
        + 
      • const { on, EventEmitter } = require('events');

        (async () => {
          const ee = new EventEmitter();

          // Emit later on
          process.nextTick(() => {
            ee.emit('foo', 'bar');
            ee.emit('foo', 42);
          });

          for await (const event of on(ee, 'foo')) {
            // The execution of this inner block is synchronous and it
            // processes one event at a time (even with await). Do not use
            // if concurrent execution is required.
            console.log(event); // prints ['bar'] [42]
          }
          // Unreachable here
        })();
        @@ -637,21 +637,21 @@ composed of the emitted event arguments.

        Parameters

        • -
          emitter: EventEmitter
          • +
          emitter: EventEmitter
        • -
          eventName: string
          +
          eventName: string

          The name of the event being listened for

        • -
          Optional options: StaticEventEmitterOptions
        -

        Returns AsyncIterableIterator<any>

      +

      Returns AsyncIterableIterator<any>

    -
    +

    Static once

    -
      - +
        +

      • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. @@ -676,34 +676,34 @@ special handling:

        Parameters

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

        Returns Promise<any[]>

      +

      Returns Promise<any[]>

      - +

    • Parameters

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

      Returns Promise<any[]>

    +

    Returns Promise<any[]>

    -
    +

    Static setMaxListeners

    -
    +
  • PoolType
    • +
  • AbstractPool
    • +
  • AbstractWorker
    • +
  • CircularArray
    • +
  • ClusterWorker
    • +
  • DynamicClusterPool
    • +
  • DynamicThreadPool
    • +
  • FixedClusterPool
    • +
  • FixedThreadPool
    • +
  • PoolEmitter
    • +
  • ThreadWorker
    • +
  • WorkerChoiceStrategyContext
    • +
  • ClusterPoolOptions
    • +
  • IPool
    • +
  • IWorker
    • +
  • IWorkerChoiceStrategy
    • +
  • MessageValue
    • +
  • PoolOptions
    • +
  • PromiseResponseWrapper
    • +
  • RequiredStatistics
    • +
  • Task
    • +
  • TasksQueueOptions
    • +
  • TasksUsage
    • +
  • WorkerChoiceStrategyOptions
    • +
  • WorkerNode
    • +
  • WorkerOptions
    • +
  • Draft
    • +
  • ErrorHandler
    • +
  • ExitHandler
    • +
  • KillBehavior
    • +
  • MessageHandler
    • +
  • OnlineHandler
    • +
  • PoolEvent
    • +
  • ThreadWorkerWithMessageChannel
    • +
  • WorkerAsyncFunction
    • +
  • WorkerChoiceStrategy
    • +
  • WorkerFunction
    • +
  • WorkerSyncFunction
    • +
  • KillBehaviors
    • +
  • PoolEvents
    • +
  • WorkerChoiceStrategies

    • Generated using TypeDoc

    \ No newline at end of file