docs: JS type hinting for the configuration (#11110)

jestjs · Apr 28, 2021 · 4c3643c · 4c3643c
1 parent 64d5983
commit 4c3643c
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 3 deletions.
diff --git a/docs/Configuration.md b/docs/Configuration.md
@@ -19,10 +19,13 @@ Or through JavaScript:
 ```js
 // jest.config.js
 // Sync object
-module.exports = {
+/** @type {import('@jest/types').Config.InitialOptions} */
+const config = {
   verbose: true,
 };
 
+module.exports = config;
+
 // Or async function
 module.exports = async () => {
   return {

diff --git a/website/versioned_docs/version-25.x/Configuration.md b/website/versioned_docs/version-25.x/Configuration.md
@@ -18,9 +18,12 @@ Or through JavaScript:
 
 ```js
 // jest.config.js
-module.exports = {
+/** @type {import('@jest/types').Config.InitialOptions} */
+const config = {
   verbose: true,
 };
+
+module.exports = config;
 ```
 
 Please keep in mind that the resulting configuration must be JSON-serializable.

diff --git a/website/versioned_docs/version-26.x/Configuration.md b/website/versioned_docs/version-26.x/Configuration.md
@@ -19,10 +19,13 @@ Or through JavaScript:
 ```js
 // jest.config.js
 // Sync object
-module.exports = {
+/** @type {import('@jest/types').Config.InitialOptions} */
+const config = {
   verbose: true,
 };
 
+module.exports = config;
+
 // Or async function
 module.exports = async () => {
   return {