docs(upgrading): detail changes to NodeEnvironment export (#12812)

jestjs · May 6, 2022 · 8433c5c · 8433c5c
1 parent 3390ec4
commit 8433c5c
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/docs/UpgradingToJest28.md b/docs/UpgradingToJest28.md
@@ -140,6 +140,16 @@ The constructor of [test environment](Configuration.md#testenvironment-string) c
 +     const config = projectConfig;
 ```
 
+In addition, test environments are now exported with the name `TestEnvironment`, instead of simply exporting the class directly:
+
+```diff
+- const TestEnvironment = require('jest-environment-node');
++ const {TestEnvironment} = require('jest-environment-node');
+
+- const TestEnvironment = require('jest-environment-jsdom');
++ const {TestEnvironment} = require('jest-environment-jsdom');
+```
+
 ### `jsdom`
 
 If you are using JSDOM [test environment](Configuration.md#testenvironment-string), `jest-environment-jsdom` package now must be installed separately:

diff --git a/website/versioned_docs/version-28.0/UpgradingToJest28.md b/website/versioned_docs/version-28.0/UpgradingToJest28.md
@@ -140,6 +140,16 @@ The constructor of [test environment](Configuration.md#testenvironment-string) c
 +     const config = projectConfig;
 ```
 
+In addition, test environments are now exported with the name `TestEnvironment`, instead of simply exporting the class directly:
+
+```diff
+- const TestEnvironment = require('jest-environment-node');
++ const {TestEnvironment} = require('jest-environment-node');
+
+- const TestEnvironment = require('jest-environment-jsdom');
++ const {TestEnvironment} = require('jest-environment-jsdom');
+```
+
 ### `jsdom`
 
 If you are using JSDOM [test environment](Configuration.md#testenvironment-string), `jest-environment-jsdom` package now must be installed separately: