feat: Improve error message when passing an Array while a single Elem…

…ent is expected (#906)
testing-library · Mar 7, 2021 · 300bfe2 · 300bfe2
1 parent f7b5c33
commit 300bfe2
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/src/__tests__/helpers.js b/src/__tests__/helpers.js
@@ -17,6 +17,11 @@ describe('window retrieval throws when given something other than a node', () =>
       `"It looks like you passed a Promise object instead of a DOM node. Did you do something like \`fireEvent.click(screen.findBy...\` when you meant to use a \`getBy\` query \`fireEvent.click(screen.getBy...\`, or await the findBy query \`fireEvent.click(await screen.findBy...\`?"`,
     )
   })
+  test('Array as node', () => {
+    expect(() => getWindowFromNode([])).toThrowErrorMatchingInlineSnapshot(
+      `"It looks like you passed an Array instead of a DOM node. Did you do something like \`fireEvent.click(screen.getAllBy...\` when you meant to use a \`getBy\` query \`fireEvent.click(screen.getBy...\`?"`,
+    )
+  })
   test('unknown as node', () => {
     expect(() => getWindowFromNode({})).toThrowErrorMatchingInlineSnapshot(
       `"Unable to find the \\"window\\" object for the given node. Please file an issue with the code that's causing you to see this error: https://github.com/testing-library/dom-testing-library/issues/new"`,

diff --git a/src/helpers.js b/src/helpers.js
@@ -92,6 +92,10 @@ function getWindowFromNode(node) {
     throw new Error(
       `It looks like you passed a Promise object instead of a DOM node. Did you do something like \`fireEvent.click(screen.findBy...\` when you meant to use a \`getBy\` query \`fireEvent.click(screen.getBy...\`, or await the findBy query \`fireEvent.click(await screen.findBy...\`?`,
     )
+  } else if (Array.isArray(node)) {
+    throw new Error(
+      `It looks like you passed an Array instead of a DOM node. Did you do something like \`fireEvent.click(screen.getAllBy...\` when you meant to use a \`getBy\` query \`fireEvent.click(screen.getBy...\`?`,
+    )
   } else {
     // The user passed something unusual to a calling function
     throw new Error(