Skip to content

Class: RabbitMQClient

Defined in: packages/microservices/src/client/rabbitmq.client.ts:75

Client proxy that communicates over RabbitMQ (AMQP via amqplib).

  • send: publishes a message with replyTo and correlationId set, then waits for a reply on an exclusive per-client queue.
  • emit: publishes without replyTo.

Requires the optional peer dependency amqplib.

Extends

Constructors

Constructor

ts
new RabbitMQClient(options): RabbitMQClient;

Defined in: packages/microservices/src/client/rabbitmq.client.ts:91

Parameters

ParameterType
optionsRabbitMQOptions

Returns

RabbitMQClient

Overrides

ClientProxy.constructor

Methods

close()

ts
close(): void;

Defined in: packages/microservices/src/client/rabbitmq.client.ts:252

Cancels the consumer, closes channel and connection.

Returns

void

Overrides

ClientProxy.close


connect()

ts
connect(): Promise<void>;

Defined in: packages/microservices/src/client/rabbitmq.client.ts:102

Connects to RabbitMQ and sets up the exclusive reply queue.

Returns

Promise<void>

Overrides

ClientProxy.connect


emit()

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

Defined in: packages/microservices/src/client/rabbitmq.client.ts:234

Publishes a fire-and-forget event to pattern.

Type Parameters

Type ParameterDefault type
Tunknown

Parameters

ParameterType
patternstring
dataT

Returns

void

Overrides

ClientProxy.emit


send()

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

Defined in: packages/microservices/src/client/rabbitmq.client.ts:186

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

Type Parameters

Type ParameterDefault type
Tunknown
Runknown

Parameters

ParameterType
patternstring
dataT

Returns

Observable<R>

Overrides

ClientProxy.send

Released under the MIT License.