Skip to content

Collector

Defined in: packages/core/src/collector.ts:19

General-purpose event collector for interactions and messages.

  • EventEmitter

K

V

new Collector<K, V>(options?): Collector<K, V>

Defined in: packages/core/src/collector.ts:64

CollectorOptions<V> = {}

Collector<K, V>

EventEmitter.constructor

readonly collected: Map<K, V>

Defined in: packages/core/src/collector.ts:20


ended: boolean = false

Defined in: packages/core/src/collector.ts:22


optional endReason?: string

Defined in: packages/core/src/collector.ts:23


readonly options: CollectorOptions<V>

Defined in: packages/core/src/collector.ts:21


totalProcessed: number = 0

Defined in: packages/core/src/collector.ts:24

[asyncIterator](): AsyncGenerator<V, void, undefined>

Defined in: packages/core/src/collector.ts:169

Yields items as they are collected until the collector ends. Items collected between iterations are buffered, not dropped.

AsyncGenerator<V, void, undefined>


optional [captureRejectionSymbol](error, event, …args): void

Defined in: node_modules/.bun/@types+node@26.6.2/node_modules/@types/node/events.d.ts:87

The Symbol.for('nodejs.rejection') method is called in case a promise rejection happens when emitting an event and captureRejections is enabled on the emitter. It is possible to use events.captureRejectionSymbol in place of Symbol.for('nodejs.rejection').

import { EventEmitter, captureRejectionSymbol } from 'node:events';
class MyClass extends EventEmitter {
constructor() {
super({ captureRejections: true });
}
[captureRejectionSymbol](err, event, ...args) {
console.log('rejection happened for', event, 'with', err, ...args);
this.destroy(err);
}
destroy(err) {
// Tear the resource down here.
}
}

Error

string | symbol

…any[]

void

v13.4.0, v12.16.0

EventEmitter.[captureRejectionSymbol]


[dispose](): void

Defined in: packages/core/src/collector.ts:198

Stops the collector (reason "disposed"); enables using collector = ....

void


addListener<E>(eventName, listener): this

Defined in: node_modules/.bun/@types+node@26.6.2/node_modules/@types/node/events.d.ts:92

Alias for emitter.on(eventName, listener).

E extends string | symbol

string | symbol

(…args) => void

this

v0.1.26

EventEmitter.addListener


emit<E>(eventName, …args): boolean

Defined in: node_modules/.bun/@types+node@26.6.2/node_modules/@types/node/events.d.ts:134

Synchronously calls each of the listeners registered for the event named eventName, 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

E extends string | symbol

string | symbol

…any[]

boolean

v0.1.26

EventEmitter.emit


eventNames(): (string | symbol)[]

Defined in: node_modules/.bun/@types+node@26.6.2/node_modules/@types/node/events.d.ts:154

Returns an array listing the events for which the emitter has registered listeners.

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) ]

(string | symbol)[]

v6.0.0

EventEmitter.eventNames


getMaxListeners(): number

Defined in: node_modules/.bun/@types+node@26.6.2/node_modules/@types/node/events.d.ts:161

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to events.defaultMaxListeners.

number

v1.0.0

EventEmitter.getMaxListeners


handle(key, item): Promise<boolean>

Defined in: packages/core/src/collector.ts:98

Handles a candidate item for collection.

K

V

Promise<boolean>


listenerCount<E>(eventName, listener?): number

Defined in: node_modules/.bun/@types+node@26.6.2/node_modules/@types/node/events.d.ts:170

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.

E extends string | symbol

string | symbol

The name of the event being listened for

(…args) => void

The event handler function

number

v3.2.0

EventEmitter.listenerCount


listeners<E>(eventName): (…args) => void[]

Defined in: node_modules/.bun/@types+node@26.6.2/node_modules/@types/node/events.d.ts:186

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] ]

E extends string | symbol

string | symbol

(…args) => void[]

v0.1.26

EventEmitter.listeners


next(): Promise<V>

Defined in: packages/core/src/collector.ts:203

Returns a Promise that resolves with the next collected item or rejects on end/timeout.

Promise<V>


off<E>(eventName, listener): this

Defined in: node_modules/.bun/@types+node@26.6.2/node_modules/@types/node/events.d.ts:191

Alias for emitter.removeListener().

E extends string | symbol

string | symbol

(…args) => void

this

v10.0.0

EventEmitter.off


on(event, listener): this

Defined in: packages/core/src/collector.ts:32

collect receives each collected item; end the collected map and the reason.

"collect"

(item) => void

this

EventEmitter.on

on(event, listener): this

Defined in: packages/core/src/collector.ts:33

collect receives each collected item; end the collected map and the reason.

"end"

(collected, reason) => void

this

EventEmitter.on

on(event, listener): this

Defined in: packages/core/src/collector.ts:37

collect receives each collected item; end the collected map and the reason.

string | symbol

(…args) => void

this

EventEmitter.on


once(event, listener): this

Defined in: packages/core/src/collector.ts:48

Like Collector.on, for one call.

"collect"

(item) => void

this

EventEmitter.once

once(event, listener): this

Defined in: packages/core/src/collector.ts:49

Like Collector.on, for one call.

"end"

(collected, reason) => void

this

EventEmitter.once

once(event, listener): this

Defined in: packages/core/src/collector.ts:53

Like Collector.on, for one call.

string | symbol

(…args) => void

this

EventEmitter.once


onDispose(cleanup): this

Defined in: packages/core/src/collector.ts:82

Registers a function to run once when the collector ends. Runs immediately if it already has.

() => void

this


prependListener<E>(eventName, listener): this

Defined in: node_modules/.bun/@types+node@26.6.2/node_modules/@types/node/events.d.ts:275

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 already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

server.prependListener('connection', (stream) => {
console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

E extends string | symbol

string | symbol

The name of the event.

(…args) => void

The callback function

this

v6.0.0

EventEmitter.prependListener


prependOnceListener<E>(eventName, listener): this

Defined in: node_modules/.bun/@types+node@26.6.2/node_modules/@types/node/events.d.ts:292

Adds a one-time listener 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.

E extends string | symbol

string | symbol

The name of the event.

(…args) => void

The callback function

this

v6.0.0

EventEmitter.prependOnceListener


rawListeners<E>(eventName): (…args) => void[]

Defined in: node_modules/.bun/@types+node@26.6.2/node_modules/@types/node/events.d.ts:326

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');

E extends string | symbol

string | symbol

(…args) => void[]

v9.4.0

EventEmitter.rawListeners


removeAllListeners<E>(eventName?): this

Defined in: node_modules/.bun/@types+node@26.6.2/node_modules/@types/node/events.d.ts:338

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.

E extends string | symbol

string | symbol

this

v0.1.26

EventEmitter.removeAllListeners


removeListener<E>(eventName, listener): this

Defined in: node_modules/.bun/@types+node@26.6.2/node_modules/@types/node/events.d.ts:425

Removes the specified listener from the listener array for the event named eventName.

const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);

removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them from emit() in progress. Subsequent events behave as expected.

import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
const callbackA = () => {
console.log('A');
myEmitter.removeListener('event', callbackB);
};
const callbackB = () => {
console.log('B');
};
myEmitter.on('event', callbackA);
myEmitter.on('event', callbackB);
// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
// A
// B
// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
// A

Because listeners are managed using an internal array, calling this will change the position indexes of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping') listener is removed:

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.

E extends string | symbol

string | symbol

(…args) => void

this

v0.1.26

EventEmitter.removeListener


setMaxListeners(n): this

Defined in: node_modules/.bun/@types+node@26.6.2/node_modules/@types/node/events.d.ts:436

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 memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.

number

this

v0.3.5

EventEmitter.setMaxListeners


stop(reason?): void

Defined in: packages/core/src/collector.ts:141

Stops the collector and emits the “end” event.

string = "user"

void


wait(): Promise<Map<K, V>>

Defined in: packages/core/src/collector.ts:160

Resolves with everything collected once the collector ends.

Promise<Map<K, V>>