fix(TS): Forbid async function as callback argument for waitFor (#572)

* fix(TS): Forbid async function as callback argument for waitFor

* fix(TS): Add tests for passing an async function to waitFor

* feat: Update kcd-scripts

Author: Lukas-Kullmann

package.json

@@ -50,7 +50,7 @@
     "jest-serializer-ansi": "^1.0.3",
     "jest-watch-select-projects": "^2.0.0",
     "jsdom": "^16.2.2",
-    "kcd-scripts": "^6.0.0"
+    "kcd-scripts": "^6.2.0"
   },
   "eslintConfig": {
     "extends": "./node_modules/kcd-scripts/eslint.js",

types/__tests__/type-tests.ts

@@ -8,7 +8,7 @@ import {
   waitFor,
   waitForElementToBeRemoved,
   MatcherOptions,
-} from '../index'
+} from '@testing-library/dom'
 
 const {
   getByText,
@@ -162,4 +162,7 @@ async function testWaitFors() {
   })
   await waitForElementToBeRemoved(getByText(element, 'apple'))
   await waitForElementToBeRemoved(getAllByText(element, 'apple'))
+
+  // $ExpectError
+  await waitFor(async () => {})
 }

types/tsconfig.json

@@ -9,9 +9,7 @@
     "strictNullChecks": true,
     "strictFunctionTypes": true,
     "noEmit": true,
-
-    // If the library is an external module (uses `export`), this allows your test file to import "mylib" instead of "./index".
-    // If the library is global (cannot be imported via `import` or `require`), leave this out.
-    "baseUrl": "."
+    "baseUrl": ".",
+    "paths": {"@testing-library/dom": ["."]}
   }
 }

types/wait-for.d.ts

@@ -1,11 +1,11 @@
 export interface waitForOptions {
-    container?: HTMLElement;
-    timeout?: number;
-    interval?: number;
-    mutationObserverOptions?: MutationObserverInit;
+  container?: HTMLElement
+  timeout?: number
+  interval?: number
+  mutationObserverOptions?: MutationObserverInit
 }
 
 export function waitFor<T>(
-    callback: () => T,
-    options?: waitForOptions,
-): Promise<T>;
+  callback: () => T extends Promise<any> ? never : T,
+  options?: waitForOptions,
+): Promise<T>