Interface: Server
Defined in: packages/microservices/src/interfaces/server.interface.ts:13
Contract that every built-in transport server must satisfy. Custom transports only need to implement CustomTransportStrategy.
Methods
addHandler()
addHandler(pattern, callback): void;Defined in: packages/microservices/src/interfaces/server.interface.ts:15
Register a handler for request-response messages matching pattern.
Parameters
| Parameter | Type |
|---|---|
pattern | string |
callback | MessageHandler |
Returns
void
close()
close(): void;Defined in: packages/microservices/src/interfaces/server.interface.ts:21
Shut down the transport and release all resources.
Returns
void
emitEvent()
emitEvent<T>(pattern, data): void;Defined in: packages/microservices/src/interfaces/server.interface.ts:19
Publish a fire-and-forget event.
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters
| Parameter | Type |
|---|---|
pattern | string |
data | T |
Returns
void
listen()
listen(callback?): void | Promise<void>;Defined in: packages/microservices/src/interfaces/server.interface.ts:26
Start the transport server.
Parameters
| Parameter | Type | Description |
|---|---|---|
callback? | (err?) => void | Called when the server is ready or has failed. |
Returns
void | Promise<void>
sendMessage()
sendMessage<T>(pattern, data): Promise<unknown>;Defined in: packages/microservices/src/interfaces/server.interface.ts:17
Send a request and wait for the response.
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters
| Parameter | Type |
|---|---|
pattern | string |
data | T |
Returns
Promise<unknown>