From 9df4a77e250c319968aea0a365480c3eb3e416a2 Mon Sep 17 00:00:00 2001
From: karishmas6 <carishmashukla28@gmail.com>
Date: Sat, 8 Jun 2024 23:06:22 +0530
Subject: [PATCH] docs: register input handlers

---
 .../src/browser-management/inputHandlers.ts   | 23 +++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/server/src/browser-management/inputHandlers.ts b/server/src/browser-management/inputHandlers.ts
index 93e471a3..544f2052 100644
--- a/server/src/browser-management/inputHandlers.ts
+++ b/server/src/browser-management/inputHandlers.ts
@@ -345,6 +345,29 @@ const handleGoForward = async (generator: WorkflowGenerator, page: Page) => {
     logger.log('debug', 'Page went forward');
 };
 
+/**
+ * Helper function for registering the handlers onto established websocket connection.
+ * Registers:
+ * - mousedownHandler
+ * - wheelHandler
+ * - mousemoveHandler
+ * - keydownHandler
+ * - keyupHandler
+ * - changeUrlHandler
+ * - refreshHandler
+ * - goBackHandler
+ * - goForwardHandler
+ * - onGenerateAction
+ * input handlers.
+ *
+ * All these handlers first generates the workflow pair data
+ * and then calls the corresponding playwright's function to emulate the input.
+ * They also ignore any user input while interpretation is in progress.
+ *
+ * @param socket websocket with established connection
+ * @returns void
+ * @category BrowserManagement
+ */
 const registerInputHandlers = (socket: Socket) => {
     socket.on("input:mousedown", onMousedown);
     socket.on("input:wheel", onWheel);