npmpackage.info

Gathering detailed insights and metrics for jest-environment-jsdom-global

Other packages similar to jest-environment-jsdom-global

jest-environment-jsdom-fourteen

1.0.1

JSDOM environment for Jest with JSDOM 14

jest-fixed-jsdom

0.0.9

A superset of the JSDOM environment for Jest that respects Node.js globals.

jest-environment-jsdom-fifteen

1.0.2

JSDOM environment for Jest with JSDOM 15

jsdom-global

3.0.2

Enable DOM in Node.js

Gathering detailed insights and metrics for jest-environment-jsdom-global

jest-environment-jsdom-global

A Jest environment that allows you to configure jsdom

4.0.0

112

MIT

JavaScript

34,153,041 3

Installations

npm install jest-environment-jsdom-global

Pull Requests

Open

1

Total

48

Closed

5

Merged

42

Issues

Open

1

Total

15

Closed

14

Releases

v4.0.0: Jest 29 and EOL for Node 12

v4.0.0

Published on 30 Aug 2022

v3.1.2: Bug fix

v3.1.2

Published on 20 May 2022

v3.1.1: README updates

v3.1.1

Published on 30 Apr 2022

v3.1.0: Jest 28 support

v3.1.0

Published on 30 Apr 2022

v3.0.0: Jest 27 support + general hygiene

v3.0.0

Published on 27 Aug 2021

v2.0.4: Update docs for JSDOM 16

v2.0.4

Published on 14 Jun 2020

View all 10 releases

Developer

simon360

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>= 14

Typescript Support

No

Node Version

NPM Version

Statistics

112 Stars

87 Commits

13 Forks

2 Watching

23 Branches

5 Contributors

Updated on 05 Nov 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

34,153,041

Last day

-13.1%

23,450

Compared to previous day

Last week

-2.6%

122,887

Compared to previous week

Last month

10%

533,470

Compared to previous month

Last year

17.4%

6,123,404

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

jest-environment-jsdom

Dev Dependencies

jest jest-environment-jsdom prettier

Versions

Jest environment for a globally-exposed JSDOM

Similar to the standard jest-environment-jsdom, but exposes jsdom so that you can reconfigure it from your test suites.

For more information, see this discussion in the Jest repository.

Before installing, please check if you need this package, particularly in light of changes in Jest 28.

Installation and configuration

Install the package with yarn:

1yarn add --dev jest-environment-jsdom-global jest-environment-jsdom

or npm:

1npm install --save-dev jest-environment-jsdom-global jest-environment-jsdom

Then, add it to your Jest configuration:

1"jest": {
2  "testEnvironment": "jest-environment-jsdom-global"
3}

For more information, see the Jest documentation on testEnvironment.

Using JSDOM in your test suite

You can access the jsdom object globally in your test suite. For example, here's a test that changes the URL for your test environment (using reconfigure):

1describe("test suite", () => {
2  it("should not fail", () => {
3    jsdom.reconfigure({
4      url: "https://www.example.com/",
5    });
6  });
7});

Frequently Asked Questions

Jest 28 update: is this package still useful?

As of Jest 28 (formal docs), you can provide options to JSDOM using inline comments in your tests. For example, to set the URL, you could write a test suite that looks like this:

/**
 * @jest-environment jsdom
 * @jest-environment-options {"url": "https://jestjs.io/"}
 */

test('use jsdom and set the URL in this test file', () => {
  expect(window.location.href).toBe('https://jestjs.io/');
});

This may solve for many previous use cases for this package, and I'd suggest using this approach rather than using jest-environment-jsdom-global if it suffices for your needs.

Why can't I use `Object.defineProperty`?

Jest's browser environment is based on JSDOM. JSDOM used to allow you to use Object.defineProperty to update certain properties on window; in particular, you could change parts of window.location, or window.top, as you need to.

However, several years ago, JSDOM's API changed; the preferred way to mock window.location and its child properties is to use reconfigure. JSDOM 11 became the default back in Jest 22; as a result, tests that used Object.defineProperty may no longer work on certain properties of window.

Currently, Jest does not expose the JSDOM reconfigure method inside test suites. The jest-environment-jsdom-global package is meant to solve this problem: it adds jsdom as a global, so you can reconfigure it within your tests.

How can I mock `window.location.href`?

In your test, you can set the URL using:

1jsdom.reconfigure({
2  url: "https://www.example.com/",
3});

How can I mock `window.location.hash`?

You need to provide a full URL, not just the hash. Similarly to above, you can do:

1jsdom.reconfigure({
2  url: "https://www.example.com/#myHash",
3});

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

1

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

3

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to jest-environment-jsdom-global

Other packages similar to jest-environment-jsdom-global

jest-environment-jsdom-global

Installations

Pull Requests

1

48

5

42

Issues

1

15

14

Releases

Developer

simon360

Developer Guide

CommonJS

>= 14

No

Statistics

Languages

Total Downloads

34,153,041

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

Dev Dependencies

Jest environment for a globally-exposed JSDOM

Installation and configuration

Using JSDOM in your test suite

Frequently Asked Questions

Jest 28 update: is this package still useful?

Why can't I use Object.defineProperty?

How can I mock window.location.href?

How can I mock window.location.hash?

10

10

10

1

1

0

0

0

0

0

0

0

3

/10

Why can't I use `Object.defineProperty`?

How can I mock `window.location.href`?

How can I mock `window.location.hash`?