From c38bca414441c69f81f83b4431d4d1ca4ad07a54 Mon Sep 17 00:00:00 2001 From: Logan Cusano Date: Sat, 15 Jul 2023 17:58:35 -0400 Subject: [PATCH] Add jsDoc to leaveServerWrapper --- Server/commands/leave.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Server/commands/leave.js b/Server/commands/leave.js index c5ad0b2..e65de07 100644 --- a/Server/commands/leave.js +++ b/Server/commands/leave.js @@ -8,6 +8,11 @@ const { checkNodeConnectionByClientId, removeNodeConnectionByNodeId, getAllConne // Global Vars const log = new DebugBuilder("server", "leave"); +/** + * + * @param {*} clientIdObject The client ID object for the node to leave the server. Either 'clientId'||'name' can be set. + * @returns + */ async function leaveServerWrapper(clientIdObject) { if (!clientIdObject.clientId || !clientIdObject.name) return log.ERROR("Tried to leave server without client ID and/or Name");