Class: RedisClient

Defined in: packages/microservices/src/client/redis.client.ts:31

Client proxy that communicates over Redis Pub/Sub.

• send: publishes to <pattern> with a unique id and subscribes to <pattern>.reply for the correlated response.
• emit: publishes to <pattern> without an id.

Requires the optional peer dependency ioredis.

Extends

• ClientProxy

Constructors

Constructor

new RedisClient(options): RedisClient;

Defined in: packages/microservices/src/client/redis.client.ts:46

Parameters

Parameter	Type
options	RedisOptions

Returns

RedisClient

Overrides

ClientProxy.constructor

Methods

close()

close(): void;

Defined in: packages/microservices/src/client/redis.client.ts:196

Disconnects both Redis clients and clears pending state.

Returns

void

Overrides

ClientProxy.close

---

connect()

connect(): Promise<void>;

Defined in: packages/microservices/src/client/redis.client.ts:57

Opens publisher and subscriber connections.

Returns

Promise<void>

Overrides

ClientProxy.connect

---

emit()

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

Defined in: packages/microservices/src/client/redis.client.ts:188

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

ClientProxy.emit

---

send()

send<T, R>(pattern, data): Observable<R>;

Defined in: packages/microservices/src/client/redis.client.ts:150

Sends a request to pattern and returns an Observable that emits the response then completes. Times out after 5 seconds.

Type Parameters

Type Parameter	Default type
T	unknown
R	unknown

Parameters

Parameter	Type
pattern	string
data	T

Returns

Observable<R>

Overrides

ClientProxy.send