Appearance

API reference@connectum/coreDocs 1.3.x

Connectum API Reference / @connectum/core / types / Server

Interface: Server ​

Defined in: packages/core/src/types.ts:424

Server interface with explicit lifecycle control

Example ​

typescript
import { createServer } from '@connectum/core';

const server = createServer({
  services: [myRoutes],
  port: 5000
});

server.on('ready', () => console.log('Server ready!'));
server.on('error', (err) => console.error('Error:', err));

await server.start();

// Later
await server.stop();

Extends ​

  • EventEmitter

Properties ​

address ​

readonly address: AddressInfo | null

Defined in: packages/core/src/types.ts:452

Current server address

Returns null until server is started

eventBus ​

readonly eventBus: EventBusLike | null

Defined in: packages/core/src/types.ts:592

Event bus instance, if configured

Returns null if no event bus was provided to createServer().

interceptors ​

readonly interceptors: readonly Interceptor[]

Defined in: packages/core/src/types.ts:580

Registered interceptors

isRunning ​

readonly isRunning: boolean

Defined in: packages/core/src/types.ts:457

Whether server is currently running

protocols ​

readonly protocols: readonly ProtocolRegistration[]

Defined in: packages/core/src/types.ts:585

Registered protocols

routes ​

readonly routes: readonly ServiceDefinition[]

Defined in: packages/core/src/types.ts:575

Registered service routes

shutdownSignal ​

readonly shutdownSignal: AbortSignal

Defined in: packages/core/src/types.ts:559

Abort signal that is aborted when server begins shutdown.

Use this to signal streaming RPCs and long-running operations that the server is shutting down.

state ​

readonly state: ServerState

Defined in: packages/core/src/types.ts:462

Current server state

transport ​

readonly transport: TransportServer | null

Defined in: packages/core/src/types.ts:570

Underlying transport server

Returns null until server is started

Methods ​

[captureRejectionSymbol]()? ​

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

Defined in: node_modules/.pnpm/@[email protected]/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').

js
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.
  }
}

Parameters ​

error ​

Error

event ​

string | symbol

args ​

...any[]

Returns ​

void

Since ​

v13.4.0, v12.16.0

Inherited from ​

EventEmitter.[captureRejectionSymbol]

addInterceptor() ​

addInterceptor(interceptor): void

Defined in: packages/core/src/types.ts:511

Add an interceptor at runtime

Parameters ​

interceptor ​

Interceptor

Returns ​

void

Throws ​

Error if server is already running

addListener() ​

addListener<E>(eventName, listener): this

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/events.d.ts:92

Alias for emitter.on(eventName, listener).

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

listener ​

(...args) => void

Returns ​

this

Since ​

v0.1.26

Inherited from ​

EventEmitter.addListener

addProtocol() ​

addProtocol(protocol): void

Defined in: packages/core/src/types.ts:518

Add a protocol at runtime

Parameters ​

protocol ​

ProtocolRegistration

Returns ​

void

Throws ​

Error if server is already running

addService() ​

addService(service): void

Defined in: packages/core/src/types.ts:504

Add a service route at runtime

Parameters ​

service ​

ServiceDefinition

Returns ​

void

Throws ​

Error if server is already running

client() ​

client<T>(service, options?): Client<T>

Defined in: packages/core/src/types.ts:659

Unified client factory: auto-routes to the in-process transport if the service is registered on this Server, otherwise to the transport supplied by the configured remoteResolver (e.g. a createGrpcTransport({ baseUrl }) to a remote peer). An optional options.endpoint hint is forwarded to the resolver.

Fail-fast (split error model): a non-local service with no remoteResolver configured is a configuration mistake → throws CatalogConfigError at the server.client(...) call. A resolver that returns null is an operational miss → ConnectError(Code.Unavailable).

Enables polyglot deployments where the same call site (server.client(S)) routes locally in a modular monolith and remotely when the service is split into a separate process — without code changes.

Type Parameters ​

T ​

T extends DescService

Parameters ​

service ​

T

options? ​

ServerClientOptions

Returns ​

Client<T>

Example ​

typescript
// Configure the resolver once; the same call works whether GreeterService
// is co-located or remote:
const server = createServer({ services: [...], remoteResolver });
const client = server.client(GreeterService);
await client.sayHello({ name: 'world' });

emit() ​

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

Defined in: node_modules/.pnpm/@[email protected]/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.

js
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

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

args ​

...any[]

Returns ​

boolean

Since ​

v0.1.26

Inherited from ​

EventEmitter.emit

eventNames() ​

eventNames(): (string | symbol)[]

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/events.d.ts:154

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

js
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 ​

EventEmitter.eventNames

getMaxListeners() ​

getMaxListeners(): number

Defined in: node_modules/.pnpm/@[email protected]/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.

Returns ​

number

Since ​

v1.0.0

Inherited from ​

EventEmitter.getMaxListeners

hasService() ​

hasService(desc): boolean

Defined in: packages/core/src/types.ts:632

Synchronous registry lookup: returns whether the given proto service descriptor is served locally by this Server. Triggers route materialization on first call.

Source of truth is the same ConnectRouter.service(desc, impl) chain used to build the HTTP handler — no separate registration step.

Parameters ​

desc ​

DescService

Returns ​

boolean

Example ​

typescript
if (server.hasService(GreeterService)) {
  // routed in-process
}

listenerCount() ​

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

Defined in: node_modules/.pnpm/@[email protected]/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.

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

The name of the event being listened for

listener? ​

(...args) => void

The event handler function

Returns ​

number

Since ​

v3.2.0

Inherited from ​

EventEmitter.listenerCount

listeners() ​

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

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/events.d.ts:186

Returns a copy of the array of listeners for the event named eventName.

js
server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

Returns ​

(...args) => void[]

Since ​

v0.1.26

Inherited from ​

EventEmitter.listeners

localClient() ​

localClient<T>(service): Client<T>

Defined in: packages/core/src/types.ts:615

Create a fully-typed ConnectRPC client that dispatches calls directly to handlers registered on this server, without opening any TCP socket.

Safe to call before server.start() — the routes are materialized lazily on first access. Once materialized, addService / addInterceptor / addProtocol will throw.

Type Parameters ​

T ​

T extends DescService

Parameters ​

service ​

T

Returns ​

Client<T>

Example ​

typescript
import { GreeterService } from './gen/greeter_pb.js';

const server = createServer({ services: [routes] });
const client = server.localClient(GreeterService);
const response = await client.sayHello({ name: 'world' });

off() ​

Call Signature ​

off(event, listener): this

Defined in: packages/core/src/types.ts:489

Remove listener for lifecycle events

Parameters ​
event ​

"start"

listener ​

() => void

Returns ​

this

Overrides ​

EventEmitter.off

Call Signature ​

off(event, listener): this

Defined in: packages/core/src/types.ts:490

Alias for emitter.removeListener().

Parameters ​
event ​

"ready"

listener ​

() => void

Returns ​

this

Since ​

v10.0.0

Overrides ​

EventEmitter.off

Call Signature ​

off(event, listener): this

Defined in: packages/core/src/types.ts:491

Alias for emitter.removeListener().

Parameters ​
event ​

"stopping"

listener ​

() => void

Returns ​

this

Since ​

v10.0.0

Overrides ​

EventEmitter.off

Call Signature ​

off(event, listener): this

Defined in: packages/core/src/types.ts:492

Alias for emitter.removeListener().

Parameters ​
event ​

"stop"

listener ​

() => void

Returns ​

this

Since ​

v10.0.0

Overrides ​

EventEmitter.off

Call Signature ​

off(event, listener): this

Defined in: packages/core/src/types.ts:493

Alias for emitter.removeListener().

Parameters ​
event ​

"error"

listener ​

(error) => void

Returns ​

this

Since ​

v10.0.0

Overrides ​

EventEmitter.off

on() ​

Call Signature ​

on(event, listener): this

Defined in: packages/core/src/types.ts:471

Register listener for lifecycle events

Parameters ​
event ​

"start"

listener ​

() => void

Returns ​

this

Overrides ​

EventEmitter.on

Call Signature ​

on(event, listener): this

Defined in: packages/core/src/types.ts:472

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

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

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.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

js
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
Parameters ​
event ​

"ready"

listener ​

() => void

The callback function

Returns ​

this

Since ​

v0.1.101

Overrides ​

EventEmitter.on

Call Signature ​

on(event, listener): this

Defined in: packages/core/src/types.ts:473

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

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

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.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

js
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
Parameters ​
event ​

"stopping"

listener ​

() => void

The callback function

Returns ​

this

Since ​

v0.1.101

Overrides ​

EventEmitter.on

Call Signature ​

on(event, listener): this

Defined in: packages/core/src/types.ts:474

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

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

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.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

js
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
Parameters ​
event ​

"stop"

listener ​

() => void

The callback function

Returns ​

this

Since ​

v0.1.101

Overrides ​

EventEmitter.on

Call Signature ​

on(event, listener): this

Defined in: packages/core/src/types.ts:475

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

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

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.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

js
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
Parameters ​
event ​

"error"

listener ​

(error) => void

The callback function

Returns ​

this

Since ​

v0.1.101

Overrides ​

EventEmitter.on

once() ​

Call Signature ​

once(event, listener): this

Defined in: packages/core/src/types.ts:480

Register one-time listener for lifecycle events

Parameters ​
event ​

"start"

listener ​

() => void

Returns ​

this

Overrides ​

EventEmitter.once

Call Signature ​

once(event, listener): this

Defined in: packages/core/src/types.ts:481

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

js
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.

js
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
Parameters ​
event ​

"ready"

listener ​

() => void

The callback function

Returns ​

this

Since ​

v0.3.0

Overrides ​

EventEmitter.once

Call Signature ​

once(event, listener): this

Defined in: packages/core/src/types.ts:482

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

js
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.

js
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
Parameters ​
event ​

"stopping"

listener ​

() => void

The callback function

Returns ​

this

Since ​

v0.3.0

Overrides ​

EventEmitter.once

Call Signature ​

once(event, listener): this

Defined in: packages/core/src/types.ts:483

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

js
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.

js
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
Parameters ​
event ​

"stop"

listener ​

() => void

The callback function

Returns ​

this

Since ​

v0.3.0

Overrides ​

EventEmitter.once

Call Signature ​

once(event, listener): this

Defined in: packages/core/src/types.ts:484

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

js
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.

js
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
Parameters ​
event ​

"error"

listener ​

(error) => void

The callback function

Returns ​

this

Since ​

v0.3.0

Overrides ​

EventEmitter.once

onShutdown() ​

Call Signature ​

onShutdown(handler): void

Defined in: packages/core/src/types.ts:530

Register an anonymous shutdown hook

Parameters ​
handler ​

ShutdownHook

Shutdown hook function

Returns ​

void

Throws ​

Error if server is already stopped

Call Signature ​

onShutdown(name, handler): void

Defined in: packages/core/src/types.ts:539

Register a named shutdown hook

Parameters ​
name ​

string

Module name for dependency resolution

handler ​

ShutdownHook

Shutdown hook function

Returns ​

void

Throws ​

Error if server is already stopped

Call Signature ​

onShutdown(name, dependencies, handler): void

Defined in: packages/core/src/types.ts:551

Register a named shutdown hook with dependencies

Dependencies are executed before this hook during shutdown.

Parameters ​
name ​

string

Module name for dependency resolution

dependencies ​

string[]

Module names that must shut down first

handler ​

ShutdownHook

Shutdown hook function

Returns ​

void

Throws ​

Error if server is already stopped

prependListener() ​

prependListener<E>(eventName, listener): this

Defined in: node_modules/.pnpm/@[email protected]/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.

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

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

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

The name of the event.

listener ​

(...args) => void

The callback function

Returns ​

this

Since ​

v6.0.0

Inherited from ​

EventEmitter.prependListener

prependOnceListener() ​

prependOnceListener<E>(eventName, listener): this

Defined in: node_modules/.pnpm/@[email protected]/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.

js
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 ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

The name of the event.

listener ​

(...args) => void

The callback function

Returns ​

this

Since ​

v6.0.0

Inherited from ​

EventEmitter.prependOnceListener

rawListeners() ​

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

Defined in: node_modules/.pnpm/@[email protected]/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()).

js
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 ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

Returns ​

(...args) => void[]

Since ​

v9.4.0

Inherited from ​

EventEmitter.rawListeners

removeAllListeners() ​

removeAllListeners<E>(eventName?): this

Defined in: node_modules/.pnpm/@[email protected]/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.

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName? ​

string | symbol

Returns ​

this

Since ​

v0.1.26

Inherited from ​

EventEmitter.removeAllListeners

removeListener() ​

removeListener<E>(eventName, listener): this

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/events.d.ts:425

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

js
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.

js
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:

js
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 ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

listener ​

(...args) => void

Returns ​

this

Since ​

v0.1.26

Inherited from ​

EventEmitter.removeListener

setMaxListeners() ​

setMaxListeners(n): this

Defined in: node_modules/.pnpm/@[email protected]/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.

Parameters ​

n ​

number

Returns ​

this

Since ​

v0.3.5

Inherited from ​

EventEmitter.setMaxListeners

start() ​

start(): Promise<void>

Defined in: packages/core/src/types.ts:434

Start the server

Returns ​

Promise<void>

Throws ​

Error if server is not in CREATED state

stop() ​

stop(): Promise<void>

Defined in: packages/core/src/types.ts:441

Stop the server gracefully

Returns ​

Promise<void>

Throws ​

Error if server is not in RUNNING state