diff --git a/doc/api/test.md b/doc/api/test.md index 0b66d79370301f..c22ac527ad6a13 100644 --- a/doc/api/test.md +++ b/doc/api/test.md @@ -373,6 +373,11 @@ Otherwise, the test is considered to be a failure. Test files must be executable by Node.js, but are not required to use the `node:test` module internally. +Each test file is executed as if it was a regular script. That is, if the test +file itself uses `node:test` to define tests, all of those tests will be +executed within a single application thread, regardless of the value of the +`concurrency` option of [`test()`][]. + ## Collecting code coverage When Node.js is started with the [`--experimental-test-coverage`][] @@ -718,7 +723,8 @@ changes: * `options` {Object} Configuration options for running tests. The following properties are supported: * `concurrency` {number|boolean} If a number is provided, - then that many files would run in parallel. + then that many test processes would run in parallel, where each process + corresponds to one test file. If `true`, it would run `os.availableParallelism() - 1` test files in parallel. If `false`, it would only run one test file at a time. @@ -782,7 +788,7 @@ changes: * `options` {Object} Configuration options for the test. The following properties are supported: * `concurrency` {number|boolean} If a number is provided, - then that many tests would run in parallel. + then that many tests would run in parallel within the application thread. If `true`, it would run `os.availableParallelism() - 1` tests in parallel. For subtests, it will be `Infinity` tests in parallel. If `false`, it would only run one test at a time. @@ -1683,7 +1689,7 @@ changes: * `options` {Object} Configuration options for the subtest. The following properties are supported: * `concurrency` {number|boolean|null} If a number is provided, - then that many tests would run in parallel. + then that many tests would run in parallel within the application thread. If `true`, it would run all subtests in parallel. If `false`, it would only run one test at a time. If unspecified, subtests inherit this value from their parent.