From 068b9205537cb2fb20677f9b6daf9b16d4a0087b Mon Sep 17 00:00:00 2001
From: Matthew Nickson <mnickson@sidingsmedia.com>
Date: Thu, 21 Apr 2022 17:10:23 +0100
Subject: [PATCH] Add JSDoc to server/socket-handlers/*

Signed-off-by: Matthew Nickson <mnickson@sidingsmedia.com>
---
 .../cloudflared-socket-handler.js              | 18 ++++++++++++++++++
 .../socket-handlers/database-socket-handler.js |  4 ++++
 server/socket-handlers/proxy-socket-handler.js |  4 ++++
 .../status-page-socket-handler.js              |  5 +++++
 4 files changed, 31 insertions(+)

diff --git a/server/socket-handlers/cloudflared-socket-handler.js b/server/socket-handlers/cloudflared-socket-handler.js
index fa20dff8d..4c34f52f5 100644
--- a/server/socket-handlers/cloudflared-socket-handler.js
+++ b/server/socket-handlers/cloudflared-socket-handler.js
@@ -6,15 +6,28 @@ const io = UptimeKumaServer.getInstance().io;
 const prefix = "cloudflared_";
 const cloudflared = new CloudflaredTunnel();
 
+/**
+ * Change running state
+ * @param {string} running Is it running?
+ * @param {string} message Message to pass
+ */
 cloudflared.change = (running, message) => {
     io.to("cloudflared").emit(prefix + "running", running);
     io.to("cloudflared").emit(prefix + "message", message);
 };
 
+/**
+ * Emit an error message
+ * @param {string} errorMessage
+ */
 cloudflared.error = (errorMessage) => {
     io.to("cloudflared").emit(prefix + "errorMessage", errorMessage);
 };
 
+/**
+ * Handler for cloudflared
+ * @param {Socket} socket Socket.io instance
+ */
 module.exports.cloudflaredSocketHandler = (socket) => {
 
     socket.on(prefix + "join", async () => {
@@ -69,6 +82,10 @@ module.exports.cloudflaredSocketHandler = (socket) => {
 
 };
 
+/**
+ * Automatically start cloudflared
+ * @param {string} token Cloudflared tunnel token
+ */
 module.exports.autoStart = async (token) => {
     if (!token) {
         token = await setting("cloudflaredTunnelToken");
@@ -85,6 +102,7 @@ module.exports.autoStart = async (token) => {
     }
 };
 
+/** Stop cloudflared */
 module.exports.stop = async () => {
     console.log("Stop cloudflared");
     if (cloudflared) {
diff --git a/server/socket-handlers/database-socket-handler.js b/server/socket-handlers/database-socket-handler.js
index 42fdb129c..041cbba06 100644
--- a/server/socket-handlers/database-socket-handler.js
+++ b/server/socket-handlers/database-socket-handler.js
@@ -1,6 +1,10 @@
 const { checkLogin } = require("../util-server");
 const Database = require("../database");
 
+/**
+ * Handlers for database
+ * @param {Socket} socket Socket.io instance
+ */
 module.exports = (socket) => {
 
     // Post or edit incident
diff --git a/server/socket-handlers/proxy-socket-handler.js b/server/socket-handlers/proxy-socket-handler.js
index 7862ff16b..e67a829ff 100644
--- a/server/socket-handlers/proxy-socket-handler.js
+++ b/server/socket-handlers/proxy-socket-handler.js
@@ -4,6 +4,10 @@ const { sendProxyList } = require("../client");
 const { UptimeKumaServer } = require("../uptime-kuma-server");
 const server = UptimeKumaServer.getInstance();
 
+/**
+ * Handlers for proxy
+ * @param {Socket} socket Socket.io instance
+ */
 module.exports.proxySocketHandler = (socket) => {
     socket.on("addProxy", async (proxy, proxyID, callback) => {
         try {
diff --git a/server/socket-handlers/status-page-socket-handler.js b/server/socket-handlers/status-page-socket-handler.js
index 20d193823..0a0dc6865 100644
--- a/server/socket-handlers/status-page-socket-handler.js
+++ b/server/socket-handlers/status-page-socket-handler.js
@@ -8,6 +8,10 @@ const apicache = require("../modules/apicache");
 const StatusPage = require("../model/status_page");
 const { UptimeKumaServer } = require("../uptime-kuma-server");
 
+/**
+ * Socket handlers for status page
+ * @param {Socket} socket Socket.io instance to add listeners on
+ */
 module.exports.statusPageSocketHandler = (socket) => {
 
     // Post or edit incident
@@ -338,6 +342,7 @@ 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
  */
 function checkSlug(slug) {
     if (typeof slug !== "string") {