docs: getElementInformation comment docs

2024-06-05 07:05:53 +05:30
parent 1b176f8e16
commit 45c51c0d32
1 changed files with 8 additions and 1 deletions
--- a/server/src/workflow-management/selector.ts
+++ b/server/src/workflow-management/selector.ts
@@ -49,7 +49,14 @@ export const getRect = async (page: Page, coordinates: Coordinates) => {
  }
 }

-
+/**
+ * Checks the basic info about an element and returns a {@link BaseActionInfo} object.
+ * If the element is not found, returns undefined.
+ * @param page The page instance.
+ * @param coordinates Coordinates of an element.
+ * @category WorkflowManagement-Selectors
+ * @returns {Promise<BaseActionInfo|undefined>}
+ */
 export const getElementInformation = async (
  page: Page,
  coordinates: Coordinates