From 4c3643c60645a3c688920a41fa3cd21b981a3fd9 Mon Sep 17 00:00:00 2001 From: Michael Date: Thu, 29 Apr 2021 00:06:53 +0200 Subject: [PATCH] docs: JS type hinting for the configuration (#11110) --- docs/Configuration.md | 5 ++++- website/versioned_docs/version-25.x/Configuration.md | 5 ++++- website/versioned_docs/version-26.x/Configuration.md | 5 ++++- 3 files changed, 12 insertions(+), 3 deletions(-) diff --git a/docs/Configuration.md b/docs/Configuration.md index 4ab9ccc08358..ed58e7ba9cad 100644 --- 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 index fe65a7d1ffcf..13fc520c28b0 100644 --- 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 index d4bd733c199d..614120470081 100644 --- 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 {