@bss-sbc/rabbitmq-connection-instance - npm Package Compare versions

Comparing version 1.0.3 to 1.0.4

package.json

 {
   "name": "@bss-sbc/rabbitmq-connection-instance",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "",
@@ -5,0 +5,0 @@ "main": "dist/rabbitmq.js",

README.md

 # RabbitMQ Connection Instance
 
+## API References
 
+`RabbitMQ`
+
+- `connect(uri: string, options?: Options): Promise<NodeJS.Timeout | undefined>;`
+
+- `publish(queue: string, exchange: string, type: string, routingKey: string, data: any): Promise<boolean | undefined>;`
+
+- `consume(queue: string, onMessage: OnMessage): Promise<Replies.Consume | undefined>;`
+
+- `stopConsume(queue: string): Promise<void>;`
+
+- `getConnection(): Connection | undefined;`
+
+- `etLogger(logger: WriteLog): void;`
+
+## Examples
+
+### Javascript
+
+```javascript
+const { RabbitMQ } = require(`@bss-sbc/rabbitmq-connection-instance`);
+
+const instance = new RabbitMQ();
+instance
+    .connect(`amqps://oronngzc:[e-mail]/oronngzc`)
+    .then(() => console.log(instance.getConnection))
+    .then(() => process.exit(0));
+
+```
+
+### Typescript (Singleton recommended)
+
+```typescript
+import { RabbitMQ } from '@bss-sbc/rabbitmq-connection-instance';
+
+class SingletonRabbitMQ extends RabbitMQ {
+    private static instance: SingletonRabbitMQ;
+    private constructor() {
+        super();
+    }
+    public static getInstance(): SingletonRabbitMQ {
+        if (!SingletonRabbitMQ.instance) {
+            SingletonRabbitMQ.instance = new SingletonRabbitMQ();
+        }
+        return SingletonRabbitMQ.instance;
+    }
+}
+
+
+SingletonRabbitMQ.getInstance()
+    .connect(`amqps://oronngzc:[e-mail]/oronngzc`)
+    .then(() => console.log(SingletonRabbitMQ.getInstance().getConnection()))
+    .then(() => process.exit(0));
+```
+

No alert changes

Improved metrics

Total package byte prevSize

12313

increased by14.4%

Number of lines in readme file

59

increased by1375%

No dependency changes