feat(rabbitmq): add generic type to publish for simple type checking (#…

…491)
golevelup · Aug 19, 2022 · 45afeb7 · 45afeb7
1 parent 241a640
commit 45afeb7
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 6 deletions.
diff --git a/packages/rabbitmq/README.md b/packages/rabbitmq/README.md
@@ -1,4 +1,3 @@
-
 # @golevelup/nestjs-rabbitmq
 
 <p align="center">
@@ -228,7 +227,6 @@ interceptedRpc() {
 }
 ```
 
-
 ```typescript
 @RabbitRPC({
   routingKey: 'intercepted-rpc-2',
@@ -412,10 +410,10 @@ export class AppController {
 If you just want to publish a message onto a RabbitMQ exchange, use the `publish` method of the `AmqpConnection` which has the following signature:
 
 ```typescript
-public publish(
+public publish<T = any>(
   exchange: string,
   routingKey: string,
-  message: any,
+  message: T,
   options?: amqplib.Options.Publish
 )
 ```
@@ -424,6 +422,14 @@ For example:
 
 ```typescript
 amqpConnection.publish('some-exchange', 'routing-key', { msg: 'hello world' });
+
+// optionally specify a type for generic type checking support
+interface CustomModel {
+  foo: string;
+  bar: string;
+}
+amqpConnection.publish<CustomModel>('some-exchange', 'routing-key', {});
+// this will now show an error that you are missing properties: foo, bar
 ```
 
 ### Requesting Data from an RPC

diff --git a/packages/rabbitmq/src/amqp/connection.ts b/packages/rabbitmq/src/amqp/connection.ts
@@ -513,10 +513,10 @@ export class AmqpConnection {
     return consumerTag;
   }
 
-  public publish(
+  public publish<T = any>(
     exchange: string,
     routingKey: string,
-    message: any,
+    message: T,
     options?: Options.Publish
   ) {
     // source amqplib channel is used directly to keep the behavior of throwing connection related errors