X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FPoolEmitter.html;h=891caea4ed8a01956d77bd918f1aadd6171727f0;hb=e5de50abad855f7e17fa2830444047d01fdd8c30;hp=70c1cc64e89516a648db627bc06dc993dff38952;hpb=1bb559f95ee0232e20550e28e4cfd3f6556cd8a8;p=poolifier.git diff --git a/docs/classes/PoolEmitter.html b/docs/classes/PoolEmitter.html index 70c1cc64..891caea4 100644 --- a/docs/classes/PoolEmitter.html +++ b/docs/classes/PoolEmitter.html @@ -17,7 +17,8 @@
Optional
options: EventEmitterOptionsStatic
Readonly
captureStatic
captureStatic
captureSets or gets the default captureRejection value for all emitters.
+Value: boolean
+Change the default captureRejections
option on all new EventEmitter
objects.
v13.4.0, v12.16.0
Inherited from EventEmitter.captureRejections
+Inherited from EventEmitterAsyncResource.captureRejections
Static
defaultInherited from EventEmitter.defaultMaxListeners
+Static
defaultBy default, a maximum of 10
listeners can be registered for any single
+event. This limit can be changed for individual EventEmitter
instances
+using the emitter.setMaxListeners(n)
method. To change the default
+for allEventEmitter
instances, the events.defaultMaxListeners
property can be used. If this value is not a positive number, a RangeError
is thrown.
Take caution when setting the events.defaultMaxListeners
because the
+change affects allEventEmitter
instances, including those created before
+the change is made. However, calling emitter.setMaxListeners(n)
still has
+precedence over events.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
, the emitter.getMaxListeners()
and emitter.setMaxListeners()
methods can be used to
+temporarily avoid this warning:
import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
// do stuff
emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});
+
+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 additional emitter
, type
, and count
properties, referring to
+the event emitter instance, the event's name and the number of attached
+listeners, respectively.
+Its name
property is set to 'MaxListenersExceededWarning'
.
v0.11.2
+Inherited from EventEmitterAsyncResource.defaultMaxListeners
Static
Readonly
errorStatic
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.
v13.6.0, v12.17.0
Inherited from EventEmitter.errorMonitor
+Inherited from EventEmitterAsyncResource.errorMonitor
Alias for emitter.on(eventName, listener)
.
v0.1.26
'error'
listener is installed.
Rest
...args: any[]Inherited from EventEmitter.addListener
+v0.1.26
+Inherited from EventEmitterAsyncResource.addListener
Synchronously calls each of the listeners registered for the event namedeventName
, in the order they were registered, passing the supplied arguments
to each.
Returns true
if the event had listeners, false
otherwise.
import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();
// First listener
myEmitter.on('event', function firstListener() {
console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
const parameters = args.join(', ');
console.log(`event with parameters ${parameters} in third listener`);
});
console.log(myEmitter.listeners('event'));
myEmitter.emit('event', 1, 2, 3, 4, 5);
// Prints:
// [
// [Function: firstListener],
// [Function: secondListener],
// [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
-
-v0.1.26
Rest
...args: any[]Inherited from EventEmitter.emit
+v0.1.26
+Inherited from EventEmitterAsyncResource.emit
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or Symbol
s.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});
const sym = Symbol('symbol');
myEE.on(sym, () => {});
console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
-
-v6.0.0
Inherited from EventEmitter.eventNames
+v6.0.0
+Inherited from EventEmitterAsyncResource.eventNames
Returns the current max listener value for the EventEmitter
which is either
set by emitter.setMaxListeners(n)
or defaults to defaultMaxListeners.
v1.0.0
Inherited from EventEmitter.getMaxListeners
+v1.0.0
+Inherited from EventEmitterAsyncResource.getMaxListeners
Returns the number of listeners listening for the event named eventName
.
If listener
is provided, it will return how many times the listener is found
in the list of the listeners of the event.
v3.2.0
The name of the event being listened for
-Optional
listener: FunctionThe event handler function
-Inherited from EventEmitter.listenerCount
+v3.2.0
+Inherited from EventEmitterAsyncResource.listenerCount
Returns a copy of the array of listeners for the event named eventName
.
server.on('connection', (stream) => {
console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
-
-v0.1.26
Inherited from EventEmitter.listeners
+v0.1.26
+Inherited from EventEmitterAsyncResource.listeners
Alias for emitter.removeListener()
.
v10.0.0
Rest
...args: any[]Inherited from EventEmitter.off
+v10.0.0
+Inherited from EventEmitterAsyncResource.off
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
@@ -296,8 +341,6 @@ times.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
-
-v0.1.101
The name of the event.
-The callback function
Rest
...args: any[]Inherited from EventEmitter.on
+v0.1.101
+Inherited from EventEmitterAsyncResource.on
Adds a one-timelistener
function for the event named eventName
. The
next time eventName
is triggered, this listener is removed and then invoked.
eventName
is triggered, this listener is removed and then
event listener to the beginning of the listeners array.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
-
-v0.3.0
The name of the event.
-The callback function
Rest
...args: any[]Inherited from EventEmitter.once
+v0.3.0
+Inherited from EventEmitterAsyncResource.once
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
@@ -380,8 +431,6 @@ times.
server.prependListener('connection', (stream) => {
console.log('someone connected!');
});
Returns a reference to the EventEmitter
, so that calls can be chained.
v6.0.0
The name of the event.
-The callback function
Rest
...args: any[]Inherited from EventEmitter.prependListener
+v6.0.0
+Inherited from EventEmitterAsyncResource.prependListener
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.
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Returns a reference to the EventEmitter
, so that calls can be chained.
v6.0.0
The name of the event.
-The callback function
Rest
...args: any[]Inherited from EventEmitter.prependOnceListener
+v6.0.0
+Inherited from EventEmitterAsyncResource.prependOnceListener
Returns a copy of the array of listeners for the event named eventName
,
including any wrappers (such as those created by .once()
).
import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));
// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];
// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();
// Logs "log once" to the console and removes the listener
logFnWrapper();
emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');
// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');
-
-v9.4.0
Inherited from EventEmitter.rawListeners
+v9.4.0
+Inherited from EventEmitterAsyncResource.rawListeners
Removes all listeners, or those of the specified eventName
.
It is bad practice to remove listeners added elsewhere in the code,
particularly when the EventEmitter
instance was created by some other
component or module (e.g. sockets or file streams).
Returns a reference to the EventEmitter
, so that calls can be chained.
v0.1.26
Optional
event: string | symbolInherited from EventEmitter.removeAllListeners
+v0.1.26
+Inherited from EventEmitterAsyncResource.removeAllListeners
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);
@@ -519,8 +578,6 @@ recently added instance. In the example the once('ping')
lis
import { EventEmitter } from 'node:events';
const ee = new EventEmitter();
function pong() {
console.log('pong');
}
ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);
ee.emit('ping');
ee.emit('ping');
Returns a reference to the EventEmitter
, so that calls can be chained.
-
-Since
v0.1.26
once('ping')
lis
Rest
...args: any[]Inherited from EventEmitter.removeListener
+v0.1.26
+Inherited from EventEmitterAsyncResource.removeListener
By default EventEmitter
s will print a warning if more than 10
listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. The emitter.setMaxListeners()
method allows the limit to be
modified for this specific EventEmitter
instance. The value can be set toInfinity
(or 0
) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter
, so that calls can be chained.
v0.3.5
Inherited from EventEmitter.setMaxListeners
+v0.3.5
+Inherited from EventEmitterAsyncResource.setMaxListeners
Static
getStatic
getReturns a copy of the array of listeners for the event named eventName
.
For EventEmitter
s this behaves exactly the same as calling .listeners
on
@@ -578,8 +639,6 @@ the emitter.
import { getEventListeners, EventEmitter } from 'node:events';
{
const ee = new EventEmitter();
const listener = () => console.log('Events are fun');
ee.on('foo', listener);
console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
}
{
const et = new EventTarget();
const listener = () => console.log('Events are fun');
et.addEventListener('foo', listener);
console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
}
-
-v15.2.0, v14.17.0
Inherited from EventEmitter.getEventListeners
+v15.2.0, v14.17.0
+Inherited from EventEmitterAsyncResource.getEventListeners
Static
listenerStatic
listenerA class method that returns the number of listeners for the given eventName
registered on the given emitter
.
import { EventEmitter, listenerCount } from 'node:events';
const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2
-
-v0.9.12
- -Since v3.2.0 - Use listenerCount
instead.
The emitter to query
-The event name
-Inherited from EventEmitter.listenerCount
+ + +v0.9.12
+ +Since v3.2.0 - Use listenerCount
instead.
Inherited from EventEmitterAsyncResource.listenerCount
Static
onStatic
onimport { on, EventEmitter } from 'node:events';
import process from 'node:process';
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
@@ -634,8 +699,6 @@ composed of the emitted event arguments.
An AbortSignal
can be used to cancel waiting on events:
import { on, EventEmitter } from 'node:events';
import process from 'node:process';
const ac = new AbortController();
(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', { signal: ac.signal })) {
// 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
})();
process.nextTick(() => ac.abort());
-
-v13.6.0, v12.16.0
The name of the event being listened for
-Optional
options: StaticEventEmitterOptionsthat iterates eventName
events emitted by the emitter
Inherited from EventEmitter.on
+ +v13.6.0, v12.16.0
+Inherited from EventEmitterAsyncResource.on
Static
onceStatic
onceCreates a Promise
that is fulfilled when the EventEmitter
emits the given
event or that is rejected if the EventEmitter
emits 'error'
while waiting.
@@ -674,8 +741,6 @@ special handling:
An AbortSignal
can be used to cancel waiting for the event:
import { EventEmitter, once } from 'node:events';
const ee = new EventEmitter();
const ac = new AbortController();
async function foo(emitter, event, signal) {
try {
await once(emitter, event, { signal });
console.log('event emitted!');
} catch (error) {
if (error.name === 'AbortError') {
console.error('Waiting for the event was canceled!');
} else {
console.error('There was an error', error.message);
}
}
}
foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!
-
-v11.13.0, v10.16.0
Optional
options: StaticEventEmitterOptionsInherited from EventEmitter.once
+v11.13.0, v10.16.0
+Inherited from EventEmitterAsyncResource.once
Optional
options: StaticEventEmitterOptionsInherited from EventEmitter.once
+Inherited from EventEmitterAsyncResource.once
Static
setStatic
setimport { setMaxListeners, EventEmitter } from 'node:events';
const target = new EventTarget();
const emitter = new EventEmitter();
setMaxListeners(5, target, emitter);
-
-v15.4.0
Optional
n: numberA non-negative number. The maximum number of listeners per EventTarget
event.
Rest
...eventTargets: (EventEmitter | _DOMEventTarget)[]Inherited from EventEmitter.setMaxListeners
+v15.4.0
+Inherited from EventEmitterAsyncResource.setMaxListeners
Generated using TypeDoc
Pool events emitter.
-