Add JS docs for server stop

mikiher · Dec 28, 2023 · 9a634e0 · 9a634e0
1 parent 21d0d43
commit 9a634e0
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/server/Server.js b/server/Server.js
@@ -284,7 +284,7 @@ class Server {
         await this.stop()
         Logger.info('Server stopped. Exiting.')
       } else {
-        Logger.info('SIGINT (Ctrl+C) received again. Exiting immediately.')        
+        Logger.info('SIGINT (Ctrl+C) received again. Exiting immediately.')
       }
       process.exit(0)
     })
@@ -395,6 +395,10 @@ class Server {
     res.sendStatus(200)
   }
 
+  /**
+   * Gracefully stop server
+   * Stops watcher and socket server
+   */
   async stop() {
     Logger.info('=== Stopping Server ===')
     await this.watcher.close()

diff --git a/server/SocketAuthority.js b/server/SocketAuthority.js
@@ -73,10 +73,15 @@ class SocketAuthority {
     }
   }
 
+  /**
+   * Closes the Socket.IO server and disconnect all clients
+   * 
+   * @param {Function} callback 
+   */
   close(callback) {
     Logger.info('[SocketAuthority] Shutting down')
     // This will close all open socket connections, and also close the underlying http server
-    if (this.io) 
+    if (this.io)
       this.io.close(callback)
     else
       callback()