Return null instead of undefined and enhance tsdoc

alveusgg · Oct 30, 2023 · badbeec · badbeec
1 parent 36d34c0
commit badbeec
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/src/utils/dom.ts b/src/utils/dom.ts
@@ -1,8 +1,10 @@
 /**
  * Finds overlay element that is visible under the cursor
- * @param e Mouse event containing cursor position
+ *
+ * @param {MouseEvent} e Mouse event containing cursor position
+ * @returns {Element|null} Element if one is visible under the cursor, null otherwise
  */
-export function visibleUnderCursor(e: MouseEvent) {
+export function visibleUnderCursor(e: MouseEvent): Element | null {
   // Get all the elements under the mouse
   const elements = document.elementsFromPoint(e.clientX, e.clientY);
 
@@ -18,4 +20,6 @@ export function visibleUnderCursor(e: MouseEvent) {
       return element;
     }
   }
+
+  return null;
 }