From 4886bbb08b7b999d1239092ddfd769df8370f3bd Mon Sep 17 00:00:00 2001 From: karishmas6 Date: Sat, 8 Jun 2024 00:27:35 +0530 Subject: [PATCH] docs: generateDataForHighlighter description --- server/src/workflow-management/classes/Generator.ts | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/server/src/workflow-management/classes/Generator.ts b/server/src/workflow-management/classes/Generator.ts index dd380853..557b37ca 100644 --- a/server/src/workflow-management/classes/Generator.ts +++ b/server/src/workflow-management/classes/Generator.ts @@ -473,7 +473,13 @@ export class WorkflowGenerator { return bestSelector; } - + /** + * Generates data for highlighting the element on client side and emits the + * highlighter event to the client. + * @param page The page to be used for obtaining data. + * @param coordinates The coordinates of the element. + * @returns {Promise} + */ public generateDataForHighlighter = async (page: Page, coordinates: Coordinates) => { const rect = await getRect(page, coordinates); const displaySelector = await this.generateSelector(page, coordinates, ActionType.Click);