Skip to content

Commit 516c775

Browse files
textbooktargos
authored andcommitted
doc: cover --experimental-test-module-mocks flag
PR-URL: #55021 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Chemi Atlow <chemi@atlow.co.il> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 6d42e44 commit 516c775

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

doc/api/test.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -2104,8 +2104,10 @@ added: v22.3.0
21042104

21052105
This function is used to mock the exports of ECMAScript modules, CommonJS
21062106
modules, and Node.js builtin modules. Any references to the original module
2107-
prior to mocking are not impacted. The following example demonstrates how a mock
2108-
is created for a module.
2107+
prior to mocking are not impacted. In order to enable module mocking, Node.js must
2108+
be started with the [`--experimental-test-module-mocks`][] command-line flag.
2109+
2110+
The following example demonstrates how a mock is created for a module.
21092111

21102112
```js
21112113
test('mocks a builtin module in both module systems', async (t) => {
@@ -3551,6 +3553,7 @@ Can be used to abort test subtasks when the test has been aborted.
35513553
[TAP]: https://testanything.org/
35523554
[TTY]: tty.md
35533555
[`--experimental-test-coverage`]: cli.md#--experimental-test-coverage
3556+
[`--experimental-test-module-mocks`]: cli.md#--experimental-test-module-mocks
35543557
[`--experimental-test-snapshots`]: cli.md#--experimental-test-snapshots
35553558
[`--import`]: cli.md#--importmodule
35563559
[`--test-concurrency`]: cli.md#--test-concurrency

0 commit comments

Comments
 (0)