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/socket-handlers/api-key-socket-handler.js

@@ -9,8 +9,9 @@ const { Settings } = require("../settings");
 const { sendAPIKeyList } = require("../client");
 
 /**
- * Handlers for Maintenance
+ * Handlers for API keys
  * @param {Socket} socket Socket.io instance
+ * @returns {void}
  */
 module.exports.apiKeySocketHandler = (socket) => {
     // Add a new api key

server/socket-handlers/cloudflared-socket-handler.js

@@ -11,6 +11,7 @@ const cloudflared = new CloudflaredTunnel();
  * Change running state
  * @param {string} running Is it running?
  * @param {string} message Message to pass
+ * @returns {void}
  */
 cloudflared.change = (running, message) => {
     io.to("cloudflared").emit(prefix + "running", running);
@@ -19,7 +20,8 @@ cloudflared.change = (running, message) => {
 
 /**
  * Emit an error message
- * @param {string} errorMessage
+ * @param {string} errorMessage Error message to send
+ * @returns {void}
  */
 cloudflared.error = (errorMessage) => {
     io.to("cloudflared").emit(prefix + "errorMessage", errorMessage);
@@ -28,6 +30,7 @@ cloudflared.error = (errorMessage) => {
 /**
  * Handler for cloudflared
  * @param {Socket} socket Socket.io instance
+ * @returns {void}
  */
 module.exports.cloudflaredSocketHandler = (socket) => {
 
@@ -89,6 +92,7 @@ module.exports.cloudflaredSocketHandler = (socket) => {
 /**
  * Automatically start cloudflared
  * @param {string} token Cloudflared tunnel token
+ * @returns {Promise<void>}
  */
 module.exports.autoStart = async (token) => {
     if (!token) {
@@ -106,7 +110,10 @@ module.exports.autoStart = async (token) => {
     }
 };
 
-/** Stop cloudflared */
+/**
+ * Stop cloudflared
+ * @returns {Promise<void>}
+ */
 module.exports.stop = async () => {
     log.info("cloudflared", "Stop cloudflared");
     if (cloudflared) {

server/socket-handlers/database-socket-handler.js

@@ -4,6 +4,7 @@ const Database = require("../database");
 /**
  * Handlers for database
  * @param {Socket} socket Socket.io instance
+ * @returns {void}
  */
 module.exports = (socket) => {
 

server/socket-handlers/docker-socket-handler.js

@@ -6,6 +6,7 @@ const { log } = require("../../src/util");
 /**
  * Handlers for docker hosts
  * @param {Socket} socket Socket.io instance
+ * @returns {void}
  */
 module.exports.dockerSocketHandler = (socket) => {
     socket.on("addDockerHost", async (dockerHost, dockerHostID, callback) => {

server/socket-handlers/general-socket-handler.js

@@ -10,7 +10,7 @@ let gameList = null;
 
 /**
  * Get a game list via GameDig
- * @returns {Object[]} list of games supported by GameDig
+ * @returns {object[]} list of games supported by GameDig
  */
 function getGameList() {
     if (gameList == null) {

server/socket-handlers/maintenance-socket-handler.js

@@ -9,6 +9,7 @@ const server = UptimeKumaServer.getInstance();
 /**
  * Handlers for Maintenance
  * @param {Socket} socket Socket.io instance
+ * @returns {void}
  */
 module.exports.maintenanceSocketHandler = (socket) => {
     // Add a new maintenance

server/socket-handlers/proxy-socket-handler.js

@@ -7,6 +7,7 @@ const server = UptimeKumaServer.getInstance();
 /**
  * Handlers for proxy
  * @param {Socket} socket Socket.io instance
+ * @returns {void}
  */
 module.exports.proxySocketHandler = (socket) => {
     socket.on("addProxy", async (proxy, proxyID, callback) => {

server/socket-handlers/status-page-socket-handler.js

@@ -11,6 +11,7 @@ const { UptimeKumaServer } = require("../uptime-kuma-server");
 /**
  * Socket handlers for status page
  * @param {Socket} socket Socket.io instance to add listeners on
+ * @returns {void}
  */
 module.exports.statusPageSocketHandler = (socket) => {
 
@@ -350,6 +351,8 @@ module.exports.statusPageSocketHandler = (socket) => {
  * Check slug a-z, 0-9, - only
  * Regex from: https://stackoverflow.com/questions/22454258/js-regex-string-validation-for-slug
  * @param {string} slug Slug to test
+ * @returns {void}
+ * @throws Slug is not valid
  */
 function checkSlug(slug) {
     if (typeof slug !== "string") {