self-hosted/uptime-kuma
1
0
Fork 0
mirror of https://github.com/louislam/uptime-kuma.git synced 2025-06-27 00:51:30 +02:00
Code Issues Actions 5 Releases Activity

Add JSDoc to server/socket-handlers/*

Browse Source 
Signed-off-by: Matthew Nickson <mnickson@sidingsmedia.com>
This commit is contained in:
Matthew Nickson
2022-04-21 17:10:23 +01:00
parent 3d04befc1f
commit 068b920553
4 changed files with 31 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
server/socket-handlers/cloudflared-socket-handler.js
View File

@ -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) {