From c6a84f2b142297d6115c290bbb04d403d60e3809 Mon Sep 17 00:00:00 2001 From: karishmas6 Date: Sat, 8 Jun 2024 23:01:38 +0530 Subject: [PATCH] docs: keydown event handler --- server/src/browser-management/inputHandlers.ts | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/server/src/browser-management/inputHandlers.ts b/server/src/browser-management/inputHandlers.ts index 29eae6ae..94e35eae 100644 --- a/server/src/browser-management/inputHandlers.ts +++ b/server/src/browser-management/inputHandlers.ts @@ -207,7 +207,16 @@ const onKeydown = async (keyboardInput: KeyboardInput) => { await handleWrapper(handleKeydown, keyboardInput); } - +/** + * A keydown event handler. + * Reproduces the keydown event on the remote browser instance + * and generates the workflow pair data. + * @param generator - the workflow generator {@link Generator} + * @param page - the active page of the remote browser + * @param key - the pressed key + * @param coordinates - the coordinates, where the keydown event happened + * @category BrowserManagement + */ const handleKeydown = async (generator: WorkflowGenerator, page: Page, { key, coordinates }: KeyboardInput) => { await page.keyboard.down(key); await generator.onKeyboardInput(key, coordinates, page);