@sora-soft/framework

---

@sora-soft/framework / IEventEmitter

Interface: IEventEmitter<T>

Defined in: packages/framework/src/interface/event.ts:3

Extends

• Omit<EventEmitter, "on" | "emit">

Type Parameters

Type Parameter
T extends { [key: string]: any; }

Properties

Property	Type	Inherited from	Defined in
[captureRejectionSymbol]?	<K>(error, event, ...args) => void	Omit.[captureRejectionSymbol]	node_modules/.pnpm/@types+node@24.12.2/node_modules/@types/node/events.d.ts:103

Methods

addListener()

addListener<K>(eventName, listener): this;

Defined in: node_modules/.pnpm/@types+node@24.12.2/node_modules/@types/node/events.d.ts:642

Alias for emitter.on(eventName, listener).

Type Parameters

Type Parameter
K

Parameters

Parameter	Type
eventName	string | symbol
listener	(...args) => void

Returns

this

Since

v0.1.26

Inherited from

Omit.addListener

---

emit()

emit<U>(event, ...args): boolean;

Defined in: packages/framework/src/interface/event.ts:8

Type Parameters

Type Parameter
U extends string | number | symbol

Parameters

Parameter	Type
event	U
...args	Parameters<T[U]>

Returns

boolean

---

eventNames()

eventNames(): (string | symbol)[];

Defined in: node_modules/.pnpm/@types+node@24.12.2/node_modules/@types/node/events.d.ts:967

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

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

Returns

(string | symbol)[]

Since

v6.0.0

Inherited from

Omit.eventNames

---

getMaxListeners()

getMaxListeners(): number;

Defined in: node_modules/.pnpm/@types+node@24.12.2/node_modules/@types/node/events.d.ts:819

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

Returns

number

Since

v1.0.0

Inherited from

Omit.getMaxListeners

---

listenerCount()

listenerCount<K>(eventName, listener?): number;

Defined in: node_modules/.pnpm/@types+node@24.12.2/node_modules/@types/node/events.d.ts:913

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.

Type Parameters

Type Parameter
K

Parameters

Parameter	Type	Description
eventName	string | symbol	The name of the event being listened for
listener?	Function	The event handler function

Returns

number

Since

v3.2.0

Inherited from

Omit.listenerCount

---

listeners()

listeners<K>(eventName): Function[];

Defined in: node_modules/.pnpm/@types+node@24.12.2/node_modules/@types/node/events.d.ts:832

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

Type Parameters

Type Parameter
K

Parameters

Parameter	Type
eventName	string | symbol

Returns

Function[]

Since

v0.1.26

Inherited from

Omit.listeners

---

off()

off<K>(eventName, listener): this;

Defined in: node_modules/.pnpm/@types+node@24.12.2/node_modules/@types/node/events.d.ts:792

Alias for emitter.removeListener().

Type Parameters

Type Parameter
K

Parameters

Parameter	Type
eventName	string | symbol
listener	(...args) => void

Returns

this

Since

v10.0.0

Inherited from

Omit.off

---

on()

on<U>(event, listener): this;

Defined in: packages/framework/src/interface/event.ts:4

Type Parameters

Type Parameter
U extends string | number | symbol

Parameters

Parameter	Type
event	U
listener	T[U]

Returns

this

---

once()

once<K>(eventName, listener): this;

Defined in: node_modules/.pnpm/@types+node@24.12.2/node_modules/@types/node/events.d.ts:704

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

server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

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

By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the 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

Type Parameters

Type Parameter
K

Parameters

Parameter	Type	Description
eventName	string | symbol	The name of the event.
listener	(...args) => void	The callback function

Returns

this

Since

v0.3.0

Inherited from

Omit.once

---

prependListener()

prependListener<K>(eventName, listener): this;

Defined in: node_modules/.pnpm/@types+node@24.12.2/node_modules/@types/node/events.d.ts:931

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.

Type Parameters

Type Parameter
K

Parameters

Parameter	Type	Description
eventName	string | symbol	The name of the event.
listener	(...args) => void	The callback function

Returns

this

Since

v6.0.0

Inherited from

Omit.prependListener

---

prependOnceListener()

prependOnceListener<K>(eventName, listener): this;

Defined in: node_modules/.pnpm/@types+node@24.12.2/node_modules/@types/node/events.d.ts:947

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.

Type Parameters

Type Parameter
K

Parameters

Parameter	Type	Description
eventName	string | symbol	The name of the event.
listener	(...args) => void	The callback function

Returns

this

Since

v6.0.0

Inherited from

Omit.prependOnceListener

---

rawListeners()

rawListeners<K>(eventName): Function[];

Defined in: node_modules/.pnpm/@types+node@24.12.2/node_modules/@types/node/events.d.ts:863

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

Type Parameters

Type Parameter
K

Parameters

Parameter	Type
eventName	string | symbol

Returns

Function[]

Since

v9.4.0

Inherited from

Omit.rawListeners

---

removeAllListeners()

removeAllListeners(eventName?): this;

Defined in: node_modules/.pnpm/@types+node@24.12.2/node_modules/@types/node/events.d.ts:803

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.

Parameters

Parameter	Type
eventName?	string | symbol

Returns

this

Since

v0.1.26

Inherited from

Omit.removeAllListeners

---

removeListener()

removeListener<K>(eventName, listener): this;

Defined in: node_modules/.pnpm/@types+node@24.12.2/node_modules/@types/node/events.d.ts:787

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 fromemit() 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 indices 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.

Type Parameters

Type Parameter
K

Parameters

Parameter	Type
eventName	string | symbol
listener	(...args) => void

Returns

this

Since

v0.1.26

Inherited from

Omit.removeListener

---

setMaxListeners()

setMaxListeners(n): this;

Defined in: node_modules/.pnpm/@types+node@24.12.2/node_modules/@types/node/events.d.ts:813

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.

Parameters

Parameter	Type
n	number

Returns

this

Since

v0.3.5

Inherited from

Omit.setMaxListeners