@fetaoily/nest-mqtt 1.0.0 → 1.0.1

package/README.md

@@ -6,12 +6,15 @@ A MQTT module for Nest.js. Compatible with emqtt.
 
 ## Installation
 
-> ⚠️ After version 0.2.0, `nest-mqtt` make a breaking change. User should add additional `mqtt` package manual.
-
 ```bash
 $ npm install nest-mqtt mqtt --save
 ```
 
+or
+```bash
+$ yarn add nest-mqtt mqtt
+```
+
 ## Usage
 
 ### Import
@@ -22,52 +25,53 @@ You can import with configuration
 
 ```typescript
 // app.module.ts
-import { Module } from '@nestjs/common';
-import { MqttModule } from 'nest-mqtt';
+import {Module} from '@nestjs/common';
+import {MqttModule} from '@fetaoily/nest-mqtt';
 
 @Module({
   imports: [MqttModule.forRoot(options)]
 })
-export class AppModule {}
+export class AppModule {
+}
 ```
 
 or use async import method
 
 ```typescript
 // app.module.ts
-import { Module } from '@nestjs/common';
-import { MqttModule } from 'nest-mqtt';
+import {Module} from '@nestjs/common';
+import {MqttModule} from '@fetaoily/nest-mqtt';
 
 @Module({
   imports: [MqttModule.forRootAsync({
     useFactory: () => options,
   })]
 })
-export class AppModule {}
+export class AppModule {
+}
 ```
 
-
 ### Subscribe
 
 You can define any subscriber or consumer in any provider. For example,
 
 ```typescript
-import { Injectable } from '@nestjs/common';
-import { Subscribe, Payload, Topic } from 'nest-mqtt';
+import {Injectable} from '@nestjs/common';
+import {Subscribe, Payload, Topic} from '@fetaoily/nest-mqtt';
 
 @Injectable()
 export class TestService {
   @Subscribe('test')
   test() {
-  
+
   }
-  
+
   @Subscribe({
     topic: 'test2',
     transform: payload => payload.toString(),
   })
   test2() {
-    
+
   }
 }
 ```
@@ -75,8 +79,8 @@ export class TestService {
 Also, you can inject parameter with decorator:
 
 ```typescript
-import { Injectable } from '@nestjs/common';
-import { Subscribe, Payload } from 'nest-mqtt';
+import {Injectable} from '@nestjs/common';
+import {Subscribe, Payload} from '@fetaoily/nest-mqtt';
 
 @Injectable()
 export class TestService {
@@ -105,21 +109,22 @@ Get the raw packet of incoming message.
 
 Get the wildcard part of topic. It will return an array of string which extract from topic. For example:
 
-When subscribe the topic "test/+/test/+" and incoming topic is "test/1/test/2", you will get the array `["1", "2"]`. 
+When subscribe the topic "test/+/test/+" and incoming topic is "test/1/test/2", you will get the array `["1", "2"]`.
 
 ### Publish
 
 Nest-mqtt wrap some functions with `Promise` and provide a provider.
 
 ```typescript
-import { Inject, Injectable } from '@nestjs/common';
-import { MqttService } from 'nest-mqtt';
+import {Inject, Injectable} from '@nestjs/common';
+import {MqttService} from '@fetaoily/nest-mqtt';
 
 @Injectable()
 export class TestService {
   constructor(
     @Inject(MqttService) private readonly mqttService: MqttService,
-  ) {}
+  ) {
+  }
 
   async testPublish() {
     this.mqttService.publish('topic', {
@@ -136,12 +141,13 @@ nest-mqtt support emq shared subscription
 
 - Global mode
 
-Module options support queue and share property for globally converting all topic to shared topic except configured in subscription options.
+Module options support queue and share property for globally converting all topic to shared topic except configured in
+subscription options.
 
 ```typescript
 // app.module.ts
-import { Module } from '@nestjs/common';
-import { MqttModule } from 'nest-mqtt';
+import {Module} from '@nestjs/common';
+import {MqttModule} from '@fetaoily/nest-mqtt';
 
 @Module({
   imports: [MqttModule.forRoot({
@@ -150,37 +156,40 @@ import { MqttModule } from 'nest-mqtt';
     share: 'group1'
   })]
 })
-export class AppModule {}
+export class AppModule {
+}
 ```
 
 - Configure in Subscribe
 
 ```typescript
-import { Injectable } from '@nestjs/common';
-import { Subscribe, Payload, Topic } from 'nest-mqtt';
+import {Injectable} from '@nestjs/common';
+import {Subscribe, Payload, Topic} from '@fetaoily/nest-mqtt';
 
 @Injectable()
 export class TestService {
   @Subscribe('test')
   test() {
-  
+
   }
-  
+
   @Subscribe({
     topic: 'test2',
     queue: true,
   })
   test2() {
-    
+
   }
 }
 ```
 
-The priority of subscribe is higher than the global mode. If you want to specify a topic do not use the shared mode, set it as false in subscribe decorator. 
+The priority of subscribe is higher than the global mode. If you want to specify a topic do not use the shared mode, set
+it as false in subscribe decorator.
 
 ## Support
 
-Nest-mqtt is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
+Nest-mqtt is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers.
+If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
 
 ## Stay in touch
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fetaoily/nest-mqtt",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A MQTT module for Nest.js",
   "author": "microud,fetaoily",
   "license": "MIT",