Class: RedisServer

Defined in: packages/microservices/src/transports/redis.server.ts:30

Transport server that uses Redis Pub/Sub for message passing.

• Request-response: client publishes to <pattern>, server publishes the response to <pattern>.reply with the originating request id.
• Fire-and-forget: client publishes to <pattern> without an id field.

Requires the optional peer dependency ioredis.

Extends

• BaseServer

Constructors

Constructor

new RedisServer(options): RedisServer;

Defined in: packages/microservices/src/transports/redis.server.ts:52

Parameters

Parameter	Type
options	RedisOptions

Returns

RedisServer

Overrides

BaseServer.constructor

Methods

[captureRejectionSymbol]()?

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

Defined in: 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.
  }
}

Parameters

Parameter	Type
error	Error
event	string | symbol
...args	any[]

Returns

void

Since

v13.4.0, v12.16.0

Inherited from

BaseServer.[captureRejectionSymbol]

---

addEventHandler()

addEventHandler(pattern, callback): void;

Defined in: packages/microservices/src/transports/redis.server.ts:143

Registers callback as a fire-and-forget event handler for pattern. The handler's return value is ignored.

Parameters

Parameter	Type
pattern	string
callback	MessageHandler

Returns

void

Overrides

BaseServer.addEventHandler

---

addHandler()

addHandler(pattern, callback): void;

Defined in: packages/microservices/src/transports/server.ts:33

Registers callback as a request-response handler for pattern. Equivalent to addMessageHandler.

Parameters

Parameter	Type
pattern	string
callback	MessageHandler

Returns

void

Inherited from

BaseServer.addHandler

---

addListener()

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

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

Alias for emitter.on(eventName, listener).

Type Parameters

Type Parameter
E extends string | symbol

Parameters

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

Returns

this

Since

v0.1.26

Inherited from

BaseServer.addListener

---

addMessageHandler()

addMessageHandler(pattern, callback): void;

Defined in: packages/microservices/src/transports/redis.server.ts:133

Registers callback as a request-response handler for pattern. The handler is expected to return a value that will be sent back to the caller.

Parameters

Parameter	Type
pattern	string
callback	MessageHandler

Returns

void

Overrides

BaseServer.addMessageHandler

---

cleanup()

protected cleanup(): void;

Defined in: packages/microservices/src/transports/server.ts:89

Removes all EventEmitter listeners and clears both handler maps. Subclasses should call this in their close() implementation to prevent memory leaks.

Returns

void

Inherited from

BaseServer.cleanup

---

close()

close(): void;

Defined in: packages/microservices/src/transports/redis.server.ts:301

Disconnects both Redis clients and clears subscriptions.

Returns

void

Overrides

BaseServer.close

---

emit()

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

Defined in: 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

Type Parameters

Type Parameter
E extends string | symbol

Parameters

Parameter	Type
eventName	string | symbol
...args	any[]

Returns

boolean

Since

v0.1.26

Inherited from

BaseServer.emit

---

emitError()

protected emitError(error): void;

Defined in: packages/microservices/src/transports/server.ts:76

Safely surfaces a transport-level error.

Node's EventEmitter throws ERR_UNHANDLED_ERROR when "error" is emitted with no registered listener, which would crash the whole process on a routine ECONNRESET, Redis blip, or malformed frame. This helper only re-emits when a listener is attached; otherwise it logs the error so it is never silently swallowed and never crashes the process.

Parameters

Parameter	Type
error	unknown

Returns

void

Inherited from

BaseServer.emitError

---

emitEvent()

emitEvent<T>(pattern, data): void;

Defined in: packages/microservices/src/transports/redis.server.ts:293

Publishes a fire-and-forget event to pattern.

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
pattern	string
data	T

Returns

void

Overrides

BaseServer.emitEvent

---

eventNames()

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

Defined in: 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) ]

Returns

(string | symbol)[]

Since

v6.0.0

Inherited from

BaseServer.eventNames

---

getMaxListeners()

getMaxListeners(): number;

Defined in: 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

BaseServer.getMaxListeners

---

handleEvent()

protected handleEvent<T>(
   pattern, 
   data, 
   ctx
): unknown;

Defined in: packages/microservices/src/transports/server.ts:116

Dispatches an incoming event to the matching event handler and returns the handler's result so transports can await it before acknowledging the message. Silently ignores events without a registered handler.

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
pattern	string
data	T
ctx	Record<string, unknown>

Returns

unknown

Inherited from

BaseServer.handleEvent

---

handleMessage()

protected handleMessage<T, R>(
   pattern, 
   data, 
   ctx
): unknown;

Defined in: packages/microservices/src/transports/server.ts:99

Dispatches an incoming request to the matching message handler.

Type Parameters

Type Parameter	Default type
T	unknown
R	unknown

Parameters

Parameter	Type
pattern	string
data	T
ctx	Record<string, unknown>

Returns

unknown

Throws

When no handler is registered for pattern.

Inherited from

BaseServer.handleMessage

---

listen()

listen(callback?): void;

Defined in: packages/microservices/src/transports/redis.server.ts:66

Establishes Redis subscriber and publisher connections then subscribes to all registered pattern channels.

Parameters

Parameter	Type
callback?	(err?) => void

Returns

void

Overrides

BaseServer.listen

---

listenerCount()

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

Defined in: 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

Type Parameter
E extends string | symbol

Parameters

Parameter	Type	Description
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

BaseServer.listenerCount

---

listeners()

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

Defined in: 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] ]

Type Parameters

Type Parameter
E extends string | symbol

Parameters

Parameter	Type
eventName	string | symbol

Returns

(...args) => void[]

Since

v0.1.26

Inherited from

BaseServer.listeners

---

off()

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

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

Alias for emitter.removeListener().

Type Parameters

Type Parameter
E extends string | symbol

Parameters

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

Returns

this

Since

v10.0.0

Inherited from

BaseServer.off

---

on()

on<E>(eventName, listener): this;

Defined in: node_modules/@types/node/events.d.ts:225

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.

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.

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

Type Parameters

Type Parameter
E extends string | symbol

Parameters

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

Returns

this

Since

v0.1.101

Inherited from

BaseServer.on

---

once()

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

Defined in: node_modules/@types/node/events.d.ts:256

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
E extends string | symbol

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

BaseServer.once

---

prependListener()

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

Defined in: 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.

Type Parameters

Type Parameter
E extends string | symbol

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

BaseServer.prependListener

---

prependOnceListener()

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

Defined in: 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.

Type Parameters

Type Parameter
E extends string | symbol

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

BaseServer.prependOnceListener

---

rawListeners()

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

Defined in: 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');

Type Parameters

Type Parameter
E extends string | symbol

Parameters

Parameter	Type
eventName	string | symbol

Returns

(...args) => void[]

Since

v9.4.0

Inherited from

BaseServer.rawListeners

---

removeAllListeners()

removeAllListeners<E>(eventName?): this;

Defined in: 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

Type Parameter
E extends string | symbol

Parameters

Parameter	Type
eventName?	string | symbol

Returns

this

Since

v0.1.26

Inherited from

BaseServer.removeAllListeners

---

removeListener()

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

Defined in: 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.

Type Parameters

Type Parameter
E extends string | symbol

Parameters

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

Returns

this

Since

v0.1.26

Inherited from

BaseServer.removeListener

---

sendMessage()

sendMessage<T>(pattern, data): Promise<unknown>;

Defined in: packages/microservices/src/transports/redis.server.ts:255

Sends a request to pattern and waits for a reply. The default timeout is 5 seconds.

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
pattern	string
data	T

Returns

Promise<unknown>

Overrides

BaseServer.sendMessage

---

setMaxListeners()

setMaxListeners(n): this;

Defined in: 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

Parameter	Type
n	number

Returns

this

Since

v0.3.5

Inherited from

BaseServer.setMaxListeners

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
eventHandlers	readonly	Map<string, MessageHandler>	Handlers for fire-and-forget event patterns.	BaseServer.eventHandlers	packages/microservices/src/transports/server.ts:27
messageHandlers	readonly	Map<string, MessageHandler>	Handlers for request-response patterns.	BaseServer.messageHandlers	packages/microservices/src/transports/server.ts:25