fix: cleanup JSdocs

This commit is contained in:
Eddie Fiorentine 2024-11-19 19:52:37 -05:00
parent 783e228406
commit 5cff54e52d

View file

@ -12,6 +12,7 @@ class SIPMonitorType extends MonitorType {
* @param {Heartbeat} heartbeat Monitor heartbeat to update * @param {Heartbeat} heartbeat Monitor heartbeat to update
* @param {UptimeKumaServer} server Uptime Kuma server * @param {UptimeKumaServer} server Uptime Kuma server
* @returns {Promise<void>} * @returns {Promise<void>}
* @throws Will throw an error if the command execution encounters any error.
*/ */
async check(monitor, heartbeat, _server) { async check(monitor, heartbeat, _server) {
try { try {
@ -25,6 +26,7 @@ class SIPMonitorType extends MonitorType {
/** /**
* Runs Sipsak options ping * Runs Sipsak options ping
* @param {string} hostname SIP server address to send options. * @param {string} hostname SIP server address to send options.
* @param {number} port SIP server port
* @param {number} timeout timeout of options reply * @param {number} timeout timeout of options reply
* @returns {Promise<string>} A Promise that resolves to the output of the Sipsak options ping * @returns {Promise<string>} A Promise that resolves to the output of the Sipsak options ping
* @throws Will throw an error if the command execution encounters any error. * @throws Will throw an error if the command execution encounters any error.
@ -41,6 +43,12 @@ class SIPMonitorType extends MonitorType {
} }
} }
/**
*
* @param {string} res
* @param {object} heartbeat
* @returns {void}
*/
parseSipsakResponse(res, heartbeat){ parseSipsakResponse(res, heartbeat){
let lines = res.split("\n"); let lines = res.split("\n");
for (let line of lines){ for (let line of lines){