Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/events.d.ts:631
listenerCount
@@ -272,7 +273,7 @@ in the list of the listeners of the event.
+
Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/events.d.ts:725
listeners
@@ -293,7 +294,7 @@ in the list of the listeners of the event.
+
Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/events.d.ts:644
off
@@ -325,7 +326,7 @@ in the list of the listeners of the event.
+
Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/events.d.ts:604
on
@@ -373,7 +374,7 @@ event listener to the beginning of the listeners array.
+
Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/events.d.ts:486
once
@@ -419,7 +420,7 @@ event listener to the beginning of the listeners array.
+
Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/events.d.ts:516
prependListener
@@ -463,7 +464,7 @@ times.
+
Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/events.d.ts:743
prependOnceListener
@@ -505,7 +506,7 @@ listener is removed, and then invoked.
+
Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/events.d.ts:759
rawListeners
@@ -527,7 +528,7 @@ including any wrappers (such as those created by .once()).
+
Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/events.d.ts:675
removeAllListeners
@@ -550,7 +551,7 @@ component or module (e.g. sockets or file streams).
+
Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/events.d.ts:615
removeListener
@@ -604,7 +605,7 @@ recently added instance. In the example the once('ping')lis
+
Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/events.d.ts:599
setMaxListeners
@@ -627,7 +628,51 @@ modified for this specific EventEmitter instance. The value can be
+
Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/events.d.ts:625
+
+
StaticaddAbortListener
+
+
addAbortListener(signal, resource): Disposable
+
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';
functionexample(signal) { letdisposable; 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
+
StaticgetEventListeners
@@ -654,7 +699,7 @@ event target. This is useful for debugging and diagnostic purposes.
+
Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/events.d.ts:296
StaticgetMaxListeners
@@ -680,9 +725,9 @@ the max set, the EventTarget will print a warning.
+
Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/events.d.ts:325
-
StaticlistenerCount
+
StaticlistenerCount
listenerCount(emitter, eventName): number
@@ -711,7 +756,7 @@ the max set, the EventTarget will print a warning.
+
Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/events.d.ts:268
Staticon
@@ -746,7 +791,7 @@ composed of the emitted event arguments.
+
Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/events.d.ts:250
Staticonce
@@ -784,7 +829,7 @@ special handling:
+
Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/events.d.ts:189
Listens once to the
+abortevent on the providedsignal.Listening to the
+abortevent on abort signals is unsafe and may +lead to resource leaks since another third party with the signal can +calle.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 thatstopImmediatePropagationdoes +not prevent the listener from running.Returns a disposable so that it may be unsubscribed from more easily.
+ +