Added JSDoc to ESLint (#3529)

* Added JSDoc to eslint rules Signed-off-by: Matthew Nickson <mnickson@sidingsmedia.com> * Fixed JSDoc eslint errors Signed-off-by: Matthew Nickson <mnickson@sidingsmedia.com> * Update the check-linters workflow to Node.js 20 --------- Signed-off-by: Matthew Nickson <mnickson@sidingsmedia.com> Co-authored-by: Louis Lam <louislam@users.noreply.github.com>
2025-08-10 02:40:18 +08:00 · 2023-08-11 09:46:41 +02:00
parent da4f4e3d76
commit 8a92054c2b
153 changed files with 1505 additions and 574 deletions
--- a/server/notification-providers/alerta.js
+++ b/server/notification-providers/alerta.js
@@ -6,6 +6,9 @@ class Alerta extends NotificationProvider {

    name = "alerta";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";

--- a/server/notification-providers/alertnow.js
+++ b/server/notification-providers/alertnow.js
@@ -7,6 +7,9 @@ class AlertNow extends NotificationProvider {

    name = "AlertNow";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";
        try {
--- a/server/notification-providers/aliyun-sms.js
+++ b/server/notification-providers/aliyun-sms.js
@@ -7,6 +7,9 @@ const qs = require("qs");
 class AliyunSMS extends NotificationProvider {
    name = "AliyunSMS";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";

@@ -78,9 +81,9 @@ class AliyunSMS extends NotificationProvider {

    /**
     * Aliyun request sign
-     * @param {Object} param Parameters object to sign
+     * @param {object} param Parameters object to sign
     * @param {string} AccessKeySecret Secret key to sign parameters with
-     * @returns {string}
+     * @returns {string} Base64 encoded request
     */
    sign(param, AccessKeySecret) {
        let param2 = {};
@@ -122,7 +125,7 @@ class AliyunSMS extends NotificationProvider {
    /**
     * Convert status constant to string
     * @param {const} status The status constant
-     * @returns {string}
+     * @returns {string} Status
     */
    statusToString(status) {
        switch (status) {
--- a/server/notification-providers/apprise.js
+++ b/server/notification-providers/apprise.js
@@ -5,6 +5,9 @@ class Apprise extends NotificationProvider {

    name = "apprise";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        const args = [ "-vv", "-b", msg, notification.appriseURL ];
        if (notification.title) {
--- a/server/notification-providers/bark.js
+++ b/server/notification-providers/bark.js
@@ -18,6 +18,9 @@ const successMessage = "Successes!";
 class Bark extends NotificationProvider {
    name = "Bark";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let barkEndpoint = notification.barkEndpoint;

@@ -45,8 +48,9 @@ class Bark extends NotificationProvider {
    /**
     * Add additional parameter for better on device styles (iOS 15
     * optimized)
+     * @param {BeanModel} notification Notification to send
     * @param {string} postUrl URL to append parameters to
-     * @returns {string}
+     * @returns {string} Additional URL parameters
     */
    appendAdditionalParameters(notification, postUrl) {
        // set icon to uptime kuma icon, 11kb should be fine
@@ -70,7 +74,8 @@ class Bark extends NotificationProvider {

    /**
     * Check if result is successful
-     * @param {Object} result Axios response object
+     * @param {object} result Axios response object
+     * @returns {void}
     * @throws {Error} The status code is not in range 2xx
     */
    checkResult(result) {
@@ -84,10 +89,11 @@ class Bark extends NotificationProvider {

    /**
     * Send the message
+     * @param {BeanModel} notification Notification to send
     * @param {string} title Message title
     * @param {string} subtitle Message
     * @param {string} endpoint Endpoint to send request to
-     * @returns {string}
+     * @returns {string} Success message
     */
    async postNotification(notification, title, subtitle, endpoint) {
        // url encode title and subtitle
--- a/server/notification-providers/clicksendsms.js
+++ b/server/notification-providers/clicksendsms.js
@@ -5,6 +5,9 @@ class ClickSendSMS extends NotificationProvider {

    name = "clicksendsms";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";
        try {
--- a/server/notification-providers/dingding.js
+++ b/server/notification-providers/dingding.js
@@ -6,6 +6,9 @@ const Crypto = require("crypto");
 class DingDing extends NotificationProvider {
    name = "DingDing";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";

@@ -39,8 +42,8 @@ class DingDing extends NotificationProvider {

    /**
     * Send message to DingDing
-     * @param {BeanModel} notification
-     * @param {Object} params Parameters of message
+     * @param {BeanModel} notification Notification to send
+     * @param {object} params Parameters of message
     * @returns {boolean} True if successful else false
     */
    async sendToDingDing(notification, params) {
@@ -66,7 +69,7 @@ class DingDing extends NotificationProvider {
     * DingDing sign
     * @param {Date} timestamp Timestamp of message
     * @param {string} secretKey Secret key to sign data with
-     * @returns {string}
+     * @returns {string} Base64 encoded signature
     */
    sign(timestamp, secretKey) {
        return Crypto
@@ -78,7 +81,7 @@ class DingDing extends NotificationProvider {
    /**
     * Convert status constant to string
     * @param {const} status The status constant
-     * @returns {string}
+     * @returns {string} Status
     */
    statusToString(status) {
        // TODO: Move to notification-provider.js to avoid repetition in classes
--- a/server/notification-providers/discord.js
+++ b/server/notification-providers/discord.js
@@ -6,6 +6,9 @@ class Discord extends NotificationProvider {

    name = "discord";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";

--- a/server/notification-providers/feishu.js
+++ b/server/notification-providers/feishu.js
@@ -5,6 +5,9 @@ const { DOWN, UP } = require("../../src/util");
 class Feishu extends NotificationProvider {
    name = "Feishu";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";
        let feishuWebHookUrl = notification.feishuWebHookUrl;
--- a/server/notification-providers/flashduty.js
+++ b/server/notification-providers/flashduty.js
@@ -7,6 +7,9 @@ const successMessage = "Sent Successfully.";
 class FlashDuty extends NotificationProvider {
    name = "FlashDuty";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        try {
            if (heartbeatJSON == null) {
@@ -33,12 +36,12 @@ class FlashDuty extends NotificationProvider {
            this.throwGeneralAxiosError(error);
        }
    }
+
    /**
     * Generate a monitor url from the monitors infomation
-     * @param {Object} monitorInfo Monitor details
-     * @returns {string|undefined}
+     * @param {object} monitorInfo Monitor details
+     * @returns {string|undefined} Monitor URL
     */
-
    genMonitorUrl(monitorInfo) {
        if (monitorInfo.type === "port" && monitorInfo.port) {
            return monitorInfo.hostname + ":" + monitorInfo.port;
@@ -54,9 +57,9 @@ class FlashDuty extends NotificationProvider {
     * @param {BeanModel} notification Message title
     * @param {string} title Message
     * @param {string} body Message
-     * @param {Object} monitorInfo Monitor details
+     * @param {object} monitorInfo Monitor details
     * @param {string} eventStatus Monitor status (Info, Warning, Critical, Ok)
-     * @returns {string}
+     * @returns {string} Success message
     */
    async postNotification(notification, title, body, monitorInfo, eventStatus) {
        const options = {
--- a/server/notification-providers/freemobile.js
+++ b/server/notification-providers/freemobile.js
@@ -5,6 +5,9 @@ class FreeMobile extends NotificationProvider {

    name = "FreeMobile";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";
        try {
--- a/server/notification-providers/goalert.js
+++ b/server/notification-providers/goalert.js
@@ -6,6 +6,9 @@ class GoAlert extends NotificationProvider {

    name = "GoAlert";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";
        try {
--- a/server/notification-providers/google-chat.js
+++ b/server/notification-providers/google-chat.js
@@ -8,6 +8,9 @@ class GoogleChat extends NotificationProvider {

    name = "GoogleChat";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";
        try {
--- a/server/notification-providers/gorush.js
+++ b/server/notification-providers/gorush.js
@@ -5,6 +5,9 @@ class Gorush extends NotificationProvider {

    name = "gorush";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";

--- a/server/notification-providers/gotify.js
+++ b/server/notification-providers/gotify.js
@@ -5,6 +5,9 @@ class Gotify extends NotificationProvider {

    name = "gotify";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";
        try {
--- a/server/notification-providers/home-assistant.js
+++ b/server/notification-providers/home-assistant.js
@@ -6,6 +6,9 @@ const defaultNotificationService = "notify";
 class HomeAssistant extends NotificationProvider {
    name = "HomeAssistant";

+    /**
+     * @inheritdoc
+     */
    async send(notification, message, monitor = null, heartbeat = null) {
        const notificationService = notification?.notificationService || defaultNotificationService;

--- a/server/notification-providers/kook.js
+++ b/server/notification-providers/kook.js
@@ -5,6 +5,9 @@ class Kook extends NotificationProvider {

    name = "Kook";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";
        let url = "https://www.kookapp.cn/api/v3/message/create";
--- a/server/notification-providers/line.js
+++ b/server/notification-providers/line.js
@@ -6,6 +6,9 @@ class Line extends NotificationProvider {

    name = "line";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";
        try {
--- a/server/notification-providers/linenotify.js
+++ b/server/notification-providers/linenotify.js
@@ -7,6 +7,9 @@ class LineNotify extends NotificationProvider {

    name = "LineNotify";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";
        try {
--- a/server/notification-providers/lunasea.js
+++ b/server/notification-providers/lunasea.js
@@ -6,6 +6,9 @@ class LunaSea extends NotificationProvider {

    name = "lunasea";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";
        let lunaseaurl = "";
--- a/server/notification-providers/matrix.js
+++ b/server/notification-providers/matrix.js
@@ -6,6 +6,9 @@ const { log } = require("../../src/util");
 class Matrix extends NotificationProvider {
    name = "matrix";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";

--- a/server/notification-providers/mattermost.js
+++ b/server/notification-providers/mattermost.js
@@ -6,6 +6,9 @@ class Mattermost extends NotificationProvider {

    name = "mattermost";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";
        try {
--- a/server/notification-providers/nostr.js
+++ b/server/notification-providers/nostr.js
@@ -33,6 +33,9 @@ if (semver.lt(nodeVersion, "16.0.0")) {
 class Nostr extends NotificationProvider {
    name = "nostr";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        // All DMs should have same timestamp
        const createdAt = Math.floor(Date.now() / 1000);
@@ -86,6 +89,11 @@ class Nostr extends NotificationProvider {
        return `${successfulRelays}/${relays.length} relays connected.`;
    }

+    /**
+     * Get the private key for the sender
+     * @param {string} sender Sender to retrieve key for
+     * @returns {nip19.DecodeResult} Private key
+     */
    async getPrivateKey(sender) {
        try {
            const senderDecodeResult = await nip19.decode(sender);
@@ -96,6 +104,11 @@ class Nostr extends NotificationProvider {
        }
    }

+    /**
+     * Get public keys for recipients
+     * @param {string} recipients Newline delimited list of recipients
+     * @returns {nip19.DecodeResult[]} Public keys
+     */
    async getPublicKeys(recipients) {
        const recipientsList = recipients.split("\n");
        const publicKeys = [];
--- a/server/notification-providers/notification-provider.js
+++ b/server/notification-providers/notification-provider.js
@@ -2,16 +2,16 @@ class NotificationProvider {

    /**
     * Notification Provider Name
-     * @type string
+     * @type {string}
     */
    name = undefined;

    /**
     * Send a notification
-     * @param {BeanModel} notification
+     * @param {BeanModel} notification Notification to send
     * @param {string} msg General Message
-     * @param {?Object} monitorJSON Monitor details (For Up/Down only)
-     * @param {?Object} heartbeatJSON Heartbeat details (For Up/Down only)
+     * @param {?object} monitorJSON Monitor details (For Up/Down only)
+     * @param {?object} heartbeatJSON Heartbeat details (For Up/Down only)
     * @returns {Promise<string>} Return Successful Message
     * @throws Error with fail msg
     */
@@ -22,6 +22,7 @@ class NotificationProvider {
    /**
     * Throws an error
     * @param {any} error The error to throw
+     * @returns {void}
     * @throws {any} The error specified
     */
    throwGeneralAxiosError(error) {
--- a/server/notification-providers/ntfy.js
+++ b/server/notification-providers/ntfy.js
@@ -6,6 +6,9 @@ class Ntfy extends NotificationProvider {

    name = "ntfy";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";
        try {
--- a/server/notification-providers/octopush.js
+++ b/server/notification-providers/octopush.js
@@ -5,6 +5,9 @@ class Octopush extends NotificationProvider {

    name = "octopush";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";

--- a/server/notification-providers/onebot.js
+++ b/server/notification-providers/onebot.js
@@ -5,6 +5,9 @@ class OneBot extends NotificationProvider {

    name = "OneBot";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";
        try {
--- a/server/notification-providers/opsgenie.js
+++ b/server/notification-providers/opsgenie.js
@@ -68,11 +68,11 @@ class Opsgenie extends NotificationProvider {
    }

    /**
-     *
-     * @param {BeanModel} notification
+     * Make POST request to Opsgenie
+     * @param {BeanModel} notification Notification to send
     * @param {string} url Request url
-     * @param {Object} data Request body
-     * @returns {Promise<string>}
+     * @param {object} data Request body
+     * @returns {Promise<string>} Success message
     */
    async post(notification, url, data) {
        let config = {
--- a/server/notification-providers/pagerduty.js
+++ b/server/notification-providers/pagerduty.js
@@ -39,7 +39,8 @@ class PagerDuty extends NotificationProvider {

    /**
     * Check if result is successful, result code should be in range 2xx
-     * @param {Object} result Axios response object
+     * @param {object} result Axios response object
+     * @returns {void}
     * @throws {Error} The status code is not in range 2xx
     */
    checkResult(result) {
@@ -56,9 +57,9 @@ class PagerDuty extends NotificationProvider {
     * @param {BeanModel} notification Message title
     * @param {string} title Message title
     * @param {string} body Message
-     * @param {Object} monitorInfo Monitor details (For Up/Down only)
+     * @param {object} monitorInfo Monitor details (For Up/Down only)
     * @param {?string} eventAction Action event for PagerDuty (trigger, acknowledge, resolve)
-     * @returns {string}
+     * @returns {Promise<string>} Success message
     */
    async postNotification(notification, title, body, monitorInfo, eventAction = "trigger") {

--- a/server/notification-providers/pagertree.js
+++ b/server/notification-providers/pagertree.js
@@ -32,7 +32,8 @@ class PagerTree extends NotificationProvider {

    /**
     * Check if result is successful, result code should be in range 2xx
-     * @param {Object} result Axios response object
+     * @param {object} result Axios response object
+     * @returns {void}
     * @throws {Error} The status code is not in range 2xx
     */
    checkResult(result) {
@@ -48,9 +49,10 @@ class PagerTree extends NotificationProvider {
     * Send the message
     * @param {BeanModel} notification Message title
     * @param {string} title Message title
-     * @param {Object} monitorJSON Monitor details (For Up/Down only)
+     * @param {object} monitorJSON Monitor details (For Up/Down only)
+     * @param {object} heartbeatJSON Heartbeat details (For Up/Down only)
     * @param {?string} eventAction Action event for PagerTree (create, resolve)
-     * @returns {string}
+     * @returns {Promise<string>} Success state
     */
    async postNotification(notification, title, monitorJSON, heartbeatJSON, eventAction = "create") {

--- a/server/notification-providers/promosms.js
+++ b/server/notification-providers/promosms.js
@@ -5,6 +5,9 @@ class PromoSMS extends NotificationProvider {

    name = "promosms";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";

--- a/server/notification-providers/pushbullet.js
+++ b/server/notification-providers/pushbullet.js
@@ -7,6 +7,9 @@ class Pushbullet extends NotificationProvider {

    name = "pushbullet";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";

--- a/server/notification-providers/pushdeer.js
+++ b/server/notification-providers/pushdeer.js
@@ -6,6 +6,9 @@ class PushDeer extends NotificationProvider {

    name = "PushDeer";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";
        let endpoint = "/message/push";
--- a/server/notification-providers/pushover.js
+++ b/server/notification-providers/pushover.js
@@ -5,6 +5,9 @@ class Pushover extends NotificationProvider {

    name = "pushover";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";
        let pushoverlink = "https://api.pushover.net/1/messages.json";
--- a/server/notification-providers/pushy.js
+++ b/server/notification-providers/pushy.js
@@ -5,6 +5,9 @@ class Pushy extends NotificationProvider {

    name = "pushy";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";

--- a/server/notification-providers/rocket-chat.js
+++ b/server/notification-providers/rocket-chat.js
@@ -8,6 +8,9 @@ class RocketChat extends NotificationProvider {

    name = "rocket.chat";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";
        try {
--- a/server/notification-providers/serverchan.js
+++ b/server/notification-providers/serverchan.js
@@ -6,6 +6,9 @@ class ServerChan extends NotificationProvider {

    name = "ServerChan";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";
        try {
@@ -23,8 +26,8 @@ class ServerChan extends NotificationProvider {

    /**
     * Get the formatted title for message
-     * @param {?Object} monitorJSON Monitor details (For Up/Down only)
-     * @param {?Object} heartbeatJSON Heartbeat details (For Up/Down only)
+     * @param {?object} heartbeatJSON Heartbeat details (For Up/Down only)
+     * @param {?object} monitorJSON Monitor details (For Up/Down only)
     * @returns {string} Formatted title
     */
    checkStatus(heartbeatJSON, monitorJSON) {
--- a/server/notification-providers/serwersms.js
+++ b/server/notification-providers/serwersms.js
@@ -5,6 +5,9 @@ class SerwerSMS extends NotificationProvider {

    name = "serwersms";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";

--- a/server/notification-providers/signal.js
+++ b/server/notification-providers/signal.js
@@ -5,6 +5,9 @@ class Signal extends NotificationProvider {

    name = "signal";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";

--- a/server/notification-providers/slack.js
+++ b/server/notification-providers/slack.js
@@ -10,7 +10,9 @@ class Slack extends NotificationProvider {
    /**
     * Deprecated property notification.slackbutton
     * Set it as primary base url if this is not yet set.
+     * @deprecated
     * @param {string} url The primary base URL to use
+     * @returns {Promise<void>}
     */
    static async deprecateURL(url) {
        let currentPrimaryBaseURL = await setting("primaryBaseURL");
@@ -25,6 +27,9 @@ class Slack extends NotificationProvider {
        }
    }

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";

--- a/server/notification-providers/smsc.js
+++ b/server/notification-providers/smsc.js
@@ -4,6 +4,9 @@ const axios = require("axios");
 class SMSC extends NotificationProvider {
    name = "smsc";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";
        try {
--- a/server/notification-providers/smseagle.js
+++ b/server/notification-providers/smseagle.js
@@ -5,6 +5,9 @@ class SMSEagle extends NotificationProvider {

    name = "SMSEagle";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";

--- a/server/notification-providers/smsmanager.js
+++ b/server/notification-providers/smsmanager.js
@@ -5,6 +5,9 @@ class SMSManager extends NotificationProvider {

    name = "SMSManager";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        try {
            let data = {
--- a/server/notification-providers/smtp.js
+++ b/server/notification-providers/smtp.js
@@ -6,6 +6,9 @@ class SMTP extends NotificationProvider {

    name = "smtp";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {

        const config = {
--- a/server/notification-providers/splunk.js
+++ b/server/notification-providers/splunk.js
@@ -37,7 +37,8 @@ class Splunk extends NotificationProvider {

    /**
     * Check if result is successful, result code should be in range 2xx
-     * @param {Object} result Axios response object
+     * @param {object} result Axios response object
+     * @returns {void}
     * @throws {Error} The status code is not in range 2xx
     */
    checkResult(result) {
@@ -54,9 +55,9 @@ class Splunk extends NotificationProvider {
     * @param {BeanModel} notification Message title
     * @param {string} title Message title
     * @param {string} body Message
-     * @param {Object} monitorInfo Monitor details (For Up/Down only)
+     * @param {object} monitorInfo Monitor details (For Up/Down only)
     * @param {?string} eventAction Action event for PagerDuty (trigger, acknowledge, resolve)
-     * @returns {string}
+     * @returns {Promise<string>} Success state
     */
    async postNotification(notification, title, body, monitorInfo, eventAction = "trigger") {

--- a/server/notification-providers/squadcast.js
+++ b/server/notification-providers/squadcast.js
@@ -6,6 +6,9 @@ class Squadcast extends NotificationProvider {

    name = "squadcast";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";

--- a/server/notification-providers/stackfield.js
+++ b/server/notification-providers/stackfield.js
@@ -7,6 +7,9 @@ class Stackfield extends NotificationProvider {

    name = "stackfield";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null) {
        let okMsg = "Sent Successfully.";
        try {
--- a/server/notification-providers/teams.js
+++ b/server/notification-providers/teams.js
@@ -9,7 +9,7 @@ class Teams extends NotificationProvider {
     * Generate the message to send
     * @param {const} status The status constant
     * @param {string} monitorName Name of monitor
-     * @returns {string}
+     * @returns {string} Status message
     */
    _statusMessageFactory = (status, monitorName) => {
        if (status === DOWN) {
@@ -37,11 +37,12 @@ class Teams extends NotificationProvider {

    /**
     * Generate payload for notification
-     * @param {const} status The status of the monitor
-     * @param {string} monitorMessage Message to send
-     * @param {string} monitorName Name of monitor affected
-     * @param {string} monitorUrl URL of monitor affected
-     * @returns {Object}
+     * @param {object} args Method arguments
+     * @param {const} args.status The status of the monitor
+     * @param {string} args.monitorMessage Message to send
+     * @param {string} args.monitorName Name of monitor affected
+     * @param {string} args.monitorUrl URL of monitor affected
+     * @returns {object} Notification payload
     */
    _notificationPayloadFactory = ({
        status,
@@ -96,7 +97,8 @@ class Teams extends NotificationProvider {
    /**
     * Send the notification
     * @param {string} webhookUrl URL to send the request to
-     * @param {Object} payload Payload generated by _notificationPayloadFactory
+     * @param {object} payload Payload generated by _notificationPayloadFactory
+     * @returns {Promise<void>}
     */
    _sendNotification = async (webhookUrl, payload) => {
        await axios.post(webhookUrl, payload);
@@ -116,6 +118,9 @@ class Teams extends NotificationProvider {
        return this._sendNotification(webhookUrl, payload);
    };

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";

--- a/server/notification-providers/techulus-push.js
+++ b/server/notification-providers/techulus-push.js
@@ -5,6 +5,9 @@ class TechulusPush extends NotificationProvider {

    name = "PushByTechulus";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";

--- a/server/notification-providers/telegram.js
+++ b/server/notification-providers/telegram.js
@@ -5,6 +5,9 @@ class Telegram extends NotificationProvider {

    name = "telegram";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";

--- a/server/notification-providers/twilio.js
+++ b/server/notification-providers/twilio.js
@@ -5,6 +5,9 @@ class Twilio extends NotificationProvider {

    name = "twilio";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {

        let okMsg = "Sent Successfully.";
--- a/server/notification-providers/webhook.js
+++ b/server/notification-providers/webhook.js
@@ -7,6 +7,9 @@ class Webhook extends NotificationProvider {

    name = "webhook";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";

--- a/server/notification-providers/wecom.js
+++ b/server/notification-providers/wecom.js
@@ -6,6 +6,9 @@ class WeCom extends NotificationProvider {

    name = "WeCom";

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";

@@ -26,9 +29,9 @@ class WeCom extends NotificationProvider {

    /**
     * Generate the message to send
-     * @param {Object} heartbeatJSON Heartbeat details (For Up/Down only)
+     * @param {object} heartbeatJSON Heartbeat details (For Up/Down only)
     * @param {string} msg General message
-     * @returns {Object}
+     * @returns {object} Message
     */
    composeMessage(heartbeatJSON, msg) {
        let title;
--- a/server/notification-providers/zoho-cliq.js
+++ b/server/notification-providers/zoho-cliq.js
@@ -10,7 +10,7 @@ class ZohoCliq extends NotificationProvider {
     * Generate the message to send
     * @param {const} status The status constant
     * @param {string} monitorName Name of monitor
-     * @returns {string}
+     * @returns {string} Status message
     */
    _statusMessageFactory = (status, monitorName) => {
        if (status === DOWN) {
@@ -25,6 +25,7 @@ class ZohoCliq extends NotificationProvider {
     * Send the notification
     * @param {string} webhookUrl URL to send the request to
     * @param {Array} payload Payload generated by _notificationPayloadFactory
+     * @returns {Promise<void>}
     */
    _sendNotification = async (webhookUrl, payload) => {
        await axios.post(webhookUrl, { text: payload.join("\n") });
@@ -32,11 +33,12 @@ class ZohoCliq extends NotificationProvider {

    /**
     * Generate payload for notification
-     * @param {const} status The status of the monitor
-     * @param {string} monitorMessage Message to send
-     * @param {string} monitorName Name of monitor affected
-     * @param {string} monitorUrl URL of monitor affected
-     * @returns {Array}
+     * @param {object} args Method arguments
+     * @param {const} args.status The status of the monitor
+     * @param {string} args.monitorMessage Message to send
+     * @param {string} args.monitorName Name of monitor affected
+     * @param {string} args.monitorUrl URL of monitor affected
+     * @returns {Array} Notification payload
     */
    _notificationPayloadFactory = ({
        status,
@@ -74,6 +76,9 @@ class ZohoCliq extends NotificationProvider {
        return this._sendNotification(webhookUrl, payload);
    };

+    /**
+     * @inheritdoc
+     */
    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
        let okMsg = "Sent Successfully.";