Added JSDoc docs for mqttAsync

Signed-off-by: Matthew Nickson <mnickson@sidingsmedia.com>
pull/1499/head
Matthew Nickson 3 years ago
parent 0083485d4c
commit c2f6c5b42e
No known key found for this signature in database
GPG Key ID: BF229DCFD4748E05

@ -108,7 +108,12 @@ exports.pingAsync = function (hostname, ipv6 = false) {
/** /**
* MQTT Monitor * 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<string>}
*/ */
exports.mqttAsync = function (hostname, topic, okMessage, options = {}) { exports.mqttAsync = function (hostname, topic, okMessage, options = {}) {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {

Loading…
Cancel
Save