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>

server/monitor-types/monitor-type.js

@@ -3,10 +3,10 @@ class MonitorType {
     name = undefined;
 
     /**
-     *
-     * @param {Monitor} monitor
-     * @param {Heartbeat} heartbeat
-     * @param {UptimeKumaServer} server
+     * Run the monitoring check on the given monitor
+     * @param {Monitor} monitor Monitor to check
+     * @param {Heartbeat} heartbeat Monitor heartbeat to update
+     * @param {UptimeKumaServer} server Uptime Kuma server
      * @returns {Promise<void>}
      */
     async check(monitor, heartbeat, server) {

server/monitor-types/real-browser-monitor-type.js

@@ -51,6 +51,11 @@ if (process.platform === "win32") {
 
 log.debug("chrome", allowedList);
 
+/**
+ * Is the executable path allowed?
+ * @param {string} executablePath Path to executable
+ * @returns {Promise<boolean>} The executable is allowed?
+ */
 async function isAllowedChromeExecutable(executablePath) {
     console.log(config.args);
     if (config.args["allow-all-chrome-exec"] || process.env.UPTIME_KUMA_ALLOW_ALL_CHROME_EXEC === "1") {
@@ -61,6 +66,11 @@ async function isAllowedChromeExecutable(executablePath) {
     return allowedList.includes(executablePath);
 }
 
+/**
+ * Get the current instance of the browser. If there isn't one, create
+ * it.
+ * @returns {Promise<Browser>} The browser
+ */
 async function getBrowser() {
     if (!browser) {
         let executablePath = await Settings.get("chromeExecutable");
@@ -75,6 +85,11 @@ async function getBrowser() {
     return browser;
 }
 
+/**
+ * Prepare the chrome executable path
+ * @param {string} executablePath Path to chrome executable
+ * @returns {Promise<string>} Executable path
+ */
 async function prepareChromeExecutable(executablePath) {
     // Special code for using the playwright_chromium
     if (typeof executablePath === "string" && executablePath.toLocaleLowerCase() === "#playwright_chromium") {
@@ -121,6 +136,12 @@ async function prepareChromeExecutable(executablePath) {
     return executablePath;
 }
 
+/**
+ * Find the chrome executable
+ * @param {any[]} executables Executables to search through
+ * @returns {any} Executable
+ * @throws Could not find executable
+ */
 function findChrome(executables) {
     // Use the last working executable, so we don't have to search for it again
     if (lastAutoDetectChromeExecutable) {
@@ -138,6 +159,10 @@ function findChrome(executables) {
     throw new Error("Chromium not found, please specify Chromium executable path in the settings page.");
 }
 
+/**
+ * Reset chrome
+ * @returns {Promise<void>}
+ */
 async function resetChrome() {
     if (browser) {
         await browser.close();
@@ -147,8 +172,8 @@ async function resetChrome() {
 
 /**
  * Test if the chrome executable is valid and return the version
- * @param executablePath
- * @returns {Promise<string>}
+ * @param {string} executablePath Path to executable
+ * @returns {Promise<string>} Chrome version
  */
 async function testChrome(executablePath) {
     try {
@@ -175,6 +200,9 @@ class RealBrowserMonitorType extends MonitorType {
 
     name = "real-browser";
 
+    /**
+     * @inheritdoc
+     */
     async check(monitor, heartbeat, server) {
         const browser = await getBrowser();
         const context = await browser.newContext();

server/monitor-types/tailscale-ping.js

@@ -13,9 +13,9 @@ class TailscalePing extends MonitorType {
     /**
      * Checks the ping status of the URL associated with the monitor.
      * It then parses the Tailscale ping command output to update the heatrbeat.
-     *
-     * @param {Object} monitor - The monitor object associated with the check.
-     * @param {Object} heartbeat - The heartbeat object to update.
+     * @param {object} monitor The monitor object associated with the check.
+     * @param {object} heartbeat The heartbeat object to update.
+     * @returns {Promise<void>}
      * @throws Will throw an error if checking Tailscale ping encounters any error
      */
     async check(monitor, heartbeat) {
@@ -31,9 +31,9 @@ class TailscalePing extends MonitorType {
 
     /**
      * Runs the Tailscale ping command to the given URL.
-     *
-     * @param {string} hostname - The hostname to ping.
-     * @returns {Promise<string>} - A Promise that resolves to the output of the Tailscale ping command
+     * @param {string} hostname The hostname to ping.
+     * @param {number} interval Interval to send ping
+     * @returns {Promise<string>} A Promise that resolves to the output of the Tailscale ping command
      * @throws Will throw an error if the command execution encounters any error.
      */
     async runTailscalePing(hostname, interval) {
@@ -61,9 +61,9 @@ class TailscalePing extends MonitorType {
 
     /**
      * Parses the output of the Tailscale ping command to update the heartbeat.
-     *
-     * @param {string} tailscaleOutput - The output of the Tailscale ping command.
-     * @param {Object} heartbeat - The heartbeat object to update.
+     * @param {string} tailscaleOutput The output of the Tailscale ping command.
+     * @param {object} heartbeat The heartbeat object to update.
+     * @returns {void}
      * @throws Will throw an eror if the output contains any unexpected string.
      */
     parseTailscaleOutput(tailscaleOutput, heartbeat) {