From c2f6c5b42e58c12666ca01312454285c059313fc Mon Sep 17 00:00:00 2001 From: Matthew Nickson Date: Thu, 21 Apr 2022 18:53:07 +0100 Subject: [PATCH] Added JSDoc docs for mqttAsync Signed-off-by: Matthew Nickson --- server/util-server.js | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/server/util-server.js b/server/util-server.js index a6d1fbb2..f7c8b967 100644 --- a/server/util-server.js +++ b/server/util-server.js @@ -108,7 +108,12 @@ exports.pingAsync = function (hostname, ipv6 = false) { /** * MQTT Monitor - * TODO: Add docs for MQTT monitor + * @param {string} hostname Hostname / address of machine to test + * @param {string} topic MQTT topic + * @param {string} okMessage Expected result + * @param {Object} [options={}] MQTT options. Contains port, username, + * password and interval (interval defaults to 20) + * @returns {Promise} */ exports.mqttAsync = function (hostname, topic, okMessage, options = {}) { return new Promise((resolve, reject) => {