Skip to content

Commit b0f0238

Browse files
richiemccollMoLow
authored andcommitted
docs: update test concurrency description / default values
PR-URL: nodejs/node#46457 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Jacob Smith <[email protected]> (cherry picked from commit 7d68b7bbfc9ffbd2ad0913972ac0b1a315679b06)
1 parent 66da6fe commit b0f0238

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -597,11 +597,10 @@ added: REPLACEME
597597
properties are supported:
598598
* `concurrency` {number|boolean} If a number is provided,
599599
then that many files would run in parallel.
600-
If truthy, it would run (number of cpu cores - 1)
601-
files in parallel.
602-
If falsy, it would only run one file at a time.
603-
If unspecified, subtests inherit this value from their parent.
604-
**Default:** `true`.
600+
If `true`, it would run `os.availableParallelism() - 1` test files in
601+
parallel.
602+
If `false`, it would only run one test file at a time.
603+
**Default:** `false`.
605604
* `files`: {Array} An array containing the list of files to run.
606605
**Default** matching files from [test runner execution model][].
607606
* `signal` {AbortSignal} Allows aborting an in-progress test execution.
@@ -631,10 +630,9 @@ run({ files: [path.resolve('./tests/test.js')] })
631630
properties are supported:
632631
- `concurrency` {number|boolean} If a number is provided,
633632
then that many tests would run in parallel.
634-
If truthy, it would run (number of cpu cores - 1)
635-
tests in parallel.
633+
If `true`, it would run `os.availableParallelism() - 1` tests in parallel.
636634
For subtests, it will be `Infinity` tests in parallel.
637-
If falsy, it would only run one test at a time.
635+
If `false`, it would only run one test at a time.
638636
If unspecified, subtests inherit this value from their parent.
639637
**Default:** `false`.
640638
- `only` {boolean} If truthy, and the test context is configured to run
@@ -1335,9 +1333,12 @@ execution of the test function. This function does not return a value.
13351333
`fn` does not have a name.
13361334
- `options` {Object} Configuration options for the subtest. The following
13371335
properties are supported:
1338-
- `concurrency` {number} The number of tests that can be run at the same time.
1336+
- `concurrency` {number|boolean|null} If a number is provided,
1337+
then that many tests would run in parallel.
1338+
If `true`, it would run all subtests in parallel.
1339+
If `false`, it would only run one test at a time.
13391340
If unspecified, subtests inherit this value from their parent.
1340-
**Default:** `1`.
1341+
**Default:** `null`.
13411342
- `only` {boolean} If truthy, and the test context is configured to run
13421343
`only` tests, then this test will be run. Otherwise, the test is skipped.
13431344
**Default:** `false`.

0 commit comments

Comments
 (0)