# @types/jest-environment-puppeteer

> TypeScript definitions for jest-environment-puppeteer

Latest version **5.0.6** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/jest-environment-puppeteer
pnpm add @types/jest-environment-puppeteer
yarn add @types/jest-environment-puppeteer
bun add @types/jest-environment-puppeteer
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 5.0.6 |
| Published | 2023-11-07 |
| First published | 2018-04-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 5.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51437 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/jest-environment-puppeteer
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jest-environment-puppeteer
- npm.io page: https://npm.io/package/@types/jest-environment-puppeteer

## Dependencies (3)

- [@jest/types](https://npm.io/package/@jest/types.md) >=24 <=27
- [@types/puppeteer](https://npm.io/package/@types/puppeteer.md) ^5.4.0
- [jest-environment-node](https://npm.io/package/jest-environment-node.md) >=24 <=27

## Recent versions

- 5.0.6 (latest) — 2023-11-07
- 5.0.3 (ts4.1) — 2022-11-02
- 5.0.2 (ts3.9) — 2022-04-28
- 5.0.0 (ts3.8) — 2022-01-25
- 4.3.2 (ts3.4) — 2020-06-24
- 4.3.0 (ts2.8) — 2019-08-12
- 2.2.0 (ts2.3) — 2018-04-05
- 5.0.5 — 2023-10-18
- 5.0.4 — 2023-09-15
- 5.0.1 — 2022-04-26
- 4.4.1 — 2020-12-08
- 4.4.0 — 2020-09-28
- 4.3.1 — 2019-08-19
- 4.0.0 — 2019-02-27
- 2.2.1 — 2018-06-26

## README

# Installation
> `npm install --save @types/jest-environment-puppeteer`

# Summary
This package contains type definitions for jest-environment-puppeteer (https://github.com/smooth-code/jest-puppeteer/tree/master/packages/jest-environment-puppeteer).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jest-environment-puppeteer.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jest-environment-puppeteer/index.d.ts)
````ts
import NodeEnvironment = require("jest-environment-node");
import { Browser, BrowserContext, Page } from "puppeteer";
import { Context } from "vm";

interface JestPuppeteer {
    /**
     * Reset global.page
     *
     * ```ts
     * beforeEach(async () => {
     *   await jestPuppeteer.resetPage()
     * })
     * ```
     */
    resetPage(): Promise<void>;

    /**
     * Reset global.browser
     *
     * ```ts
     * beforeEach(async () => {
     *   await jestPuppeteer.resetBrowser()
     * })
     * ```
     */
    resetBrowser(): Promise<void>;

    /**
     * Suspends test execution and gives you opportunity to see what's going on in the browser
     * - Jest is suspended (no timeout)
     * - A debugger instruction to Chromium, if Puppeteer has been launched with { devtools: true } it will stop
     *
     * ```ts
     * it('should put test in debug mode', async () => {
     *   await jestPuppeteer.debug()
     * })
     * ```
     */
    debug(): Promise<void>;
}

interface Global extends NonNullable<NodeEnvironment["global"]> {
    browser: Browser;
    context: Context;
    page: Page;
    jestPuppeteer: JestPuppeteer;
}

/** Note: TestEnvironment is sandboxed. Each test suite will trigger setup/teardown in their own TestEnvironment. */
declare class PuppeteerEnvironment extends NodeEnvironment {
    global: Global;
}

declare global {
    const browser: Browser;
    const context: BrowserContext;
    const page: Page;
    const jestPuppeteer: JestPuppeteer;
}

export = PuppeteerEnvironment;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 03:09:37 GMT
 * 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)

# Credits
These definitions were written by [Ifiok Jr.](https://github.com/ifiokjr).

---
_Source: https://npm.io/package/@types/jest-environment-puppeteer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._