X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FPoolEmitter.html;h=9965bec956166c045bc042eac7f40ae09a1bd1c9;hb=f8350486e75b15ed17249cda3d0a55ee807a6a9f;hp=af82c68f0cd6bbe74472db35632d5e2a7bc7e10f;hpb=dea288f11483ea6c15807b20e4c621483c7fa5af;p=poolifier.git
diff --git a/docs/classes/PoolEmitter.html b/docs/classes/PoolEmitter.html
index af82c68f..9965bec9 100644
--- a/docs/classes/PoolEmitter.html
+++ b/docs/classes/PoolEmitter.html
@@ -25,7 +25,7 @@
+Defined in src/pools/pool.ts:35
@@ -78,44 +78,75 @@
Optional
options : EventEmitterOptions
-Inherited from EventEmitter.constructor
+Inherited from EventEmitterAsyncResource.constructor
-Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:109
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:109
Properties
Static
Readonly
capture Rejection Symbol
-
-Inherited from EventEmitter.captureRejectionSymbol
+
+
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:326
Static
capture Rejections
capture Rejections : boolean
-
-Inherited from EventEmitter.addListener
+Inherited from EventEmitterAsyncResource.addListener
-Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:348
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:390
emit
@@ -170,9 +201,9 @@ to each.
Rest
... args : any []
Returns boolean
-Inherited from EventEmitter.emit
+Inherited from EventEmitterAsyncResource.emit
-Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:610
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:652
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:715
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:567
listener Count
@@ -226,9 +257,9 @@ in the list of the listeners of the event.
Returns number
-Inherited from EventEmitter.listenerCount
+Inherited from EventEmitterAsyncResource.listenerCount
-Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:619
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:661
listeners
@@ -246,9 +277,9 @@ in the list of the listeners of the event.
eventName : string | symbol
Returns Function []
-Inherited from EventEmitter.listeners
+Inherited from EventEmitterAsyncResource.listeners
-Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:538
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:580
off
@@ -277,9 +308,9 @@ in the list of the listeners of the event.
Rest
... args : any []
Returns void
-Inherited from EventEmitter.off
+Inherited from EventEmitterAsyncResource.off
-Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:498
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:540
on
@@ -322,9 +353,9 @@ event listener to the beginning of the listeners array.
Rest
... args : any []
Returns void
-Inherited from EventEmitter.on
+Inherited from EventEmitterAsyncResource.on
-Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:380
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:422
once
@@ -365,9 +396,9 @@ event listener to the beginning of the listeners array.
Rest
... args : any []
Returns void
-Inherited from EventEmitter.once
+Inherited from EventEmitterAsyncResource.once
-Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:410
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:452
prepend Listener
@@ -406,9 +437,9 @@ times.
Rest
... args : any []
Returns void
-Inherited from EventEmitter.prependListener
+Inherited from EventEmitterAsyncResource.prependListener
-Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:637
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:679
prepend Once Listener
@@ -445,9 +476,9 @@ listener is removed, and then invoked.
Rest
... args : any []
Returns void
-Inherited from EventEmitter.prependOnceListener
+Inherited from EventEmitterAsyncResource.prependOnceListener
-Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:653
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:695
raw Listeners
@@ -466,9 +497,9 @@ including any wrappers (such as those created by .once()
).
eventName : string | symbol
Returns Function []
-Inherited from EventEmitter.rawListeners
+Inherited from EventEmitterAsyncResource.rawListeners
-Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:569
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:611
remove All Listeners
@@ -488,9 +519,9 @@ component or module (e.g. sockets or file streams).
Optional
event : string | symbol
-Inherited from EventEmitter.removeAllListeners
+Inherited from EventEmitterAsyncResource.removeAllListeners
-Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:509
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:551
remove Listener
@@ -541,9 +572,9 @@ recently added instance. In the example the once('ping')
lis
Rest
... args : any []
Returns void
-Inherited from EventEmitter.removeListener
+Inherited from EventEmitterAsyncResource.removeListener
-Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:493
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:535
set Max Listeners
@@ -563,9 +594,9 @@ modified for this specific EventEmitter
instance. The value can be
n : number
-Inherited from EventEmitter.setMaxListeners
+Inherited from EventEmitterAsyncResource.setMaxListeners
-Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:519
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:561
Static
get Event Listeners
@@ -589,9 +620,9 @@ event target. This is useful for debugging and diagnostic purposes.
name : string | symbol
Returns Function []
-Inherited from EventEmitter.getEventListeners
+Inherited from EventEmitterAsyncResource.getEventListeners
-Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:296
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:296
Static
listener Count
@@ -617,9 +648,9 @@ event target. This is useful for debugging and diagnostic purposes.
Returns number
-Inherited from EventEmitter.listenerCount
+Inherited from EventEmitterAsyncResource.listenerCount
-Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:268
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:268
Static
on
@@ -650,9 +681,9 @@ composed of the emitted event arguments.
Optional
options : StaticEventEmitterOptions
Returns AsyncIterableIterator < any > that iterates eventName
events emitted by the emitter
-Inherited from EventEmitter.on
+Inherited from EventEmitterAsyncResource.on
-Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:250
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:250
Static
once
@@ -687,9 +718,9 @@ special handling:
Optional
options : StaticEventEmitterOptions
Returns Promise < any [] >
-Inherited from EventEmitter.once
+Inherited from EventEmitterAsyncResource.once
-Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:189
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:189
once ( emitter , eventName , options ? ) : Promise < any [] >
@@ -702,9 +733,9 @@ special handling:
Optional
options : StaticEventEmitterOptions
Returns Promise < any [] >
-Inherited from EventEmitter.once
+Inherited from EventEmitterAsyncResource.once
-Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:190
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:190
Static
set Max Listeners
@@ -725,9 +756,9 @@ special handling:
Rest
... eventTargets : ( EventEmitter | _DOMEventTarget ) []
Returns void
-Inherited from EventEmitter.setMaxListeners
+Inherited from EventEmitterAsyncResource.setMaxListeners
-Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:311
+Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/events.d.ts:311
Sets or gets the default captureRejection value for all emitters.
+Value: boolean
+Change the default
+ +captureRejections
option on all newEventEmitter
objects.Since
v13.4.0, v12.16.0
Inherited from EventEmitter.captureRejections
+Inherited from EventEmitterAsyncResource.captureRejections
-- Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:327
Max Listeners
-Static
defaultInherited from EventEmitter.defaultMaxListeners
+By default, a maximum of
+10
listeners can be registered for any single +event. This limit can be changed for individualEventEmitter
instances +using theemitter.setMaxListeners(n)
method. To change the default +for allEventEmitter
instances, theevents.defaultMaxListeners
property can be used. If this value is not a positive number, aRangeError
is thrown.Take caution when setting the
+events.defaultMaxListeners
because the +change affects allEventEmitter
instances, including those created before +the change is made. However, callingemitter.setMaxListeners(n)
still has +precedence overevents.defaultMaxListeners
.This is not a hard limit. The
+ +EventEmitter
instance will allow +more listeners to be added but will output a trace warning to stderr indicating +that a "possible EventEmitter memory leak" has been detected. For any singleEventEmitter
, theemitter.getMaxListeners()
andemitter.setMaxListeners()
methods can be used to +temporarily avoid this warning:The
+--trace-warnings
command-line flag can be used to display the +stack trace for such warnings.The emitted warning can be inspected with
+ +process.on('warning')
and will +have the additionalemitter
,type
, andcount
properties, referring to +the event emitter instance, the event's name and the number of attached +listeners, respectively. +Itsname
property is set to'MaxListenersExceededWarning'
.Since
v0.11.2
+Inherited from EventEmitterAsyncResource.defaultMaxListeners
-- Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:328
Static
Readonly
errorThis 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.Installing a listener using this symbol does not change the behavior once an -
'error'
event is emitted, therefore the process will still crash if no +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.Installing a listener using this symbol does not change the behavior once an
+ +'error'
event is emitted. Therefore, the process will still crash if no regular'error'
listener is installed.Since
v13.6.0, v12.17.0
Inherited from EventEmitter.errorMonitor
+Inherited from EventEmitterAsyncResource.errorMonitor
-- Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/events.d.ts:321
Methods
'error'
listener is installed.Rest
...args: any[]Returns void