fix: fix types resolution for expect-puppeteer (#599)

Author: mulekick

README.md

@@ -131,7 +131,7 @@ async function getConfig() {
 module.exports = getConfig();
 ```
 
-## Recipes
+## <a name="recipes"></a>Recipes
 
 ### Enhance testing with `expect-puppeteer` lib
 
@@ -490,6 +490,30 @@ beforeEach(async () => {
 
 TypeScript is natively supported from v8.0.0, for previous versions, you have to use [community-provided types](https://github.com/DefinitelyTyped/DefinitelyTyped).
 
+Note though that it still requires installation of the [type definitions for jest](https://www.npmjs.com/package/@types/jest) :
+
+```bash
+npm install --save-dev @types/jest
+```
+
+Once setup, import the modules to enable types resolution for the exposed globals, then write your test logic [the same way you would in Javascript](#recipes).
+
+```ts
+// import globals
+import "jest-puppeteer";
+import "expect-puppeteer";
+
+describe("Google", (): void => {
+  beforeAll(async (): Promise<void> => {
+    await page.goto("https://google.com");
+  });
+
+  it('should display "google" text on page', async (): Promise<void> => {
+    await expect(page).toMatchTextContent("google");
+  });
+});
+```
+
 ### CI Timeout
 
 Most Continuous Integration (CI) platforms restrict the number of threads you can use. If you run multiple test suites, the tests may timeout due to Jest attempting to run Puppeteer in parallel, and the CI platform being unable to process all parallel jobs in time.

package-lock.json

@@ -4,6 +4,7 @@
     "packages/*"
   ],
   "scripts": {
+    "typecheck": "npx tsc && echo 'type checking was successful'",
     "build": "cross-env NODE_ENV=production lerna run build",
     "dev": "lerna watch -- lerna run build --scope=\\$LERNA_PACKAGE_NAME",
     "format": "prettier --write .",

package.json

@@ -1,4 +1,8 @@
-import { getDefaultOptions, setDefaultOptions } from ".";
+import { getDefaultOptions, setDefaultOptions } from "expect-puppeteer";
+
+// import globals
+import "jest-puppeteer";
+import "expect-puppeteer";
 
 expect.addSnapshotSerializer({
   print: () => "hello",