docs: generateDataForHighlighter description

This commit is contained in:
karishmas6
2024-06-08 00:27:35 +05:30
parent b6c4de7184
commit 4886bbb08b

View File

@@ -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<void>}
*/
public generateDataForHighlighter = async (page: Page, coordinates: Coordinates) => {
const rect = await getRect(page, coordinates);
const displaySelector = await this.generateSelector(page, coordinates, ActionType.Click);