1 | # Installation
|
2 | > `npm install --save @types/jest-environment-puppeteer`
|
3 |
|
4 | # Summary
|
5 | This package contains type definitions for jest-environment-puppeteer (https://github.com/smooth-code/jest-puppeteer/tree/master/packages/jest-environment-puppeteer).
|
6 |
|
7 | # Details
|
8 | Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jest-environment-puppeteer.
|
9 | ## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jest-environment-puppeteer/index.d.ts)
|
10 | ````ts
|
11 | import NodeEnvironment = require("jest-environment-node");
|
12 | import { Browser, BrowserContext, Page } from "puppeteer";
|
13 | import { Context } from "vm";
|
14 |
|
15 | interface JestPuppeteer {
|
16 | /**
|
17 | * Reset global.page
|
18 | *
|
19 | * ```ts
|
20 | * beforeEach(async () => {
|
21 | * await jestPuppeteer.resetPage()
|
22 | * })
|
23 | * ```
|
24 | */
|
25 | resetPage(): Promise<void>;
|
26 |
|
27 | /**
|
28 | * Reset global.browser
|
29 | *
|
30 | * ```ts
|
31 | * beforeEach(async () => {
|
32 | * await jestPuppeteer.resetBrowser()
|
33 | * })
|
34 | * ```
|
35 | */
|
36 | resetBrowser(): Promise<void>;
|
37 |
|
38 | /**
|
39 | * Suspends test execution and gives you opportunity to see what's going on in the browser
|
40 | * - Jest is suspended (no timeout)
|
41 | * - A debugger instruction to Chromium, if Puppeteer has been launched with { devtools: true } it will stop
|
42 | *
|
43 | * ```ts
|
44 | * it('should put test in debug mode', async () => {
|
45 | * await jestPuppeteer.debug()
|
46 | * })
|
47 | * ```
|
48 | */
|
49 | debug(): Promise<void>;
|
50 | }
|
51 |
|
52 | interface Global extends NonNullable<NodeEnvironment["global"]> {
|
53 | browser: Browser;
|
54 | context: Context;
|
55 | page: Page;
|
56 | jestPuppeteer: JestPuppeteer;
|
57 | }
|
58 |
|
59 | /** Note: TestEnvironment is sandboxed. Each test suite will trigger setup/teardown in their own TestEnvironment. */
|
60 | declare class PuppeteerEnvironment extends NodeEnvironment {
|
61 | global: Global;
|
62 | }
|
63 |
|
64 | declare global {
|
65 | const browser: Browser;
|
66 | const context: BrowserContext;
|
67 | const page: Page;
|
68 | const jestPuppeteer: JestPuppeteer;
|
69 | }
|
70 |
|
71 | export = PuppeteerEnvironment;
|
72 |
|
73 | ````
|
74 |
|
75 | ### Additional Details
|
76 | * Last updated: Tue, 07 Nov 2023 03:09:37 GMT
|
77 | * Dependencies: [@jest/types](https://npmjs.com/package/@jest/types), [@types/puppeteer](https://npmjs.com/package/@types/puppeteer), [jest-environment-node](https://npmjs.com/package/jest-environment-node)
|
78 |
|
79 | # Credits
|
80 | These definitions were written by [Ifiok Jr.](https://github.com/ifiokjr).
|
81 |
|
\ | No newline at end of file |