Clarify publish behavior. Resolves #125.

sclausen · Jan 3, 2019 · 1d8ffb9 · 1d8ffb9
1 parent 9c9d348
commit 1d8ffb9
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/src/mqtt.service.ts b/src/mqtt.service.ts
@@ -215,9 +215,10 @@ export class MqttService {
   }
 
   /**
-   * This method publishes a message for a topic with optional options.
-   * The returned observable will emit empty value and complete, if publishing was successful
-   * and will throw an error, if the publication fails.
+   * This method returns an observable for a topic with optional options.
+   * After subscribing, the actual mqtt publication will be executed and
+   * the observable will emit an empty value and completes, if publishing was successful
+   * or throws an error, if the publication fails.
    */
   public publish(topic: string, message: any, options?: IPublishOptions): Observable<void> {
     if (!this.client) {