Abstract Class: ClientProxy

Defined in: packages/microservices/src/client/client-proxy.ts:10

Abstract base class for all microservice client proxies.

Concrete implementations are transport-specific and are created by ClientFactory. Use the Client decorator to inject a proxy instance into a class property.

Extended by

• RabbitMQClient
• RedisClient
• TcpClient

Constructors

Constructor

new ClientProxy(): ClientProxy;

Returns

ClientProxy

Methods

close()

abstract close(): void;

Defined in: packages/microservices/src/client/client-proxy.ts:18

Closes the transport connection and releases resources.

Returns

void

---

connect()

abstract connect(): Promise<void>;

Defined in: packages/microservices/src/client/client-proxy.ts:15

Opens the underlying transport connection. Must be called before invoking send or emit.

Returns

Promise<void>

---

emit()

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

Defined in: packages/microservices/src/client/client-proxy.ts:45

Publishes a fire-and-forget event matching pattern.

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type	Description
pattern	string	Target event pattern.
data	T	Event payload.

Returns

void

---

send()

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

Defined in: packages/microservices/src/client/client-proxy.ts:34

Sends a request matching pattern and returns an Observable that emits the server's response then completes.

Type Parameters

Type Parameter	Default type
T	unknown
R	unknown

Parameters

Parameter	Type	Description
pattern	string	Target message pattern.
data	T	Request payload.

Returns

Observable<R>

Example

this.client.send<number>('sum', [1, 2, 3]).subscribe(result => {
  console.log(result); // 6
});