Infra-Mirrors/uptime-kuma
1
0
Fork 0
mirror of https://github.com/louislam/uptime-kuma.git synced 2025-01-15 17:27:36 -05:00
Code Issues Packages Projects Releases Wiki Activity

Added JSDoc docs for mqttAsync

Browse Source 
Signed-off-by: Matthew Nickson <mnickson@sidingsmedia.com>
This commit is contained in:
Matthew Nickson 2022-04-21 18:53:07 +01:00
parent 0083485d4c
commit c2f6c5b42e
No known key found for this signature in database
GPG Key ID: BF229DCFD4748E05
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
server/util-server.js
View File

@ -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) => {