Document helper functions

thefrontside · Dec 2, 2020 · 4a87ffd · 4a87ffd
1 parent bc564ad
commit 4a87ffd
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/packages/interactor/src/fill-in.ts b/packages/interactor/src/fill-in.ts
@@ -52,6 +52,14 @@ function setValue(element: TextFieldElement, value: string): void {
   }
 }
 
+/**
+ * Fill in text into an element by emulating how a user would do it, first
+ * focusing the element, then filling in the text letter by letter, generating
+ * the appropriate keyboard events.
+ *
+ * @param element The element to fill in text in
+ * @param value The text value to fill in
+ */
 export function fillIn(element: TextFieldElement, value: string) {
   let originalValue = element.value;
 

diff --git a/packages/interactor/src/focused.ts b/packages/interactor/src/focused.ts
@@ -1,3 +1,6 @@
+/**
+ * Helper function for focused filters, returns whether the given element is focused.
+ */
 export function focused(element: Element): boolean {
   return element.ownerDocument.activeElement === element;
 }