Add jsDoc to leaveServerWrapper

This commit is contained in:
Logan Cusano
2023-07-15 17:58:35 -04:00
parent e6332dffc9
commit c38bca4144

View File

@@ -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");