Skip to content

Commit 375bb22

Browse files
richiemccollMylesBorins
authored andcommitted
doc: update test concurrency description / default values
PR-URL: #46457 Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jacob Smith <jacob@frende.me>
1 parent a7beac0 commit 375bb22

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

doc/api/test.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -674,11 +674,10 @@ added: v18.9.0
674674
properties are supported:
675675
* `concurrency` {number|boolean} If a number is provided,
676676
then that many files would run in parallel.
677-
If truthy, it would run (number of cpu cores - 1)
678-
files in parallel.
679-
If falsy, it would only run one file at a time.
680-
If unspecified, subtests inherit this value from their parent.
681-
**Default:** `true`.
677+
If `true`, it would run `os.availableParallelism() - 1` test files in
678+
parallel.
679+
If `false`, it would only run one test file at a time.
680+
**Default:** `false`.
682681
* `files`: {Array} An array containing the list of files to run.
683682
**Default** matching files from [test runner execution model][].
684683
* `signal` {AbortSignal} Allows aborting an in-progress test execution.
@@ -724,10 +723,9 @@ changes:
724723
properties are supported:
725724
* `concurrency` {number|boolean} If a number is provided,
726725
then that many tests would run in parallel.
727-
If truthy, it would run (number of cpu cores - 1)
728-
tests in parallel.
726+
If `true`, it would run `os.availableParallelism() - 1` tests in parallel.
729727
For subtests, it will be `Infinity` tests in parallel.
730-
If falsy, it would only run one test at a time.
728+
If `false`, it would only run one test at a time.
731729
If unspecified, subtests inherit this value from their parent.
732730
**Default:** `false`.
733731
* `only` {boolean} If truthy, and the test context is configured to run
@@ -1609,9 +1607,12 @@ changes:
16091607
`fn` does not have a name.
16101608
* `options` {Object} Configuration options for the subtest. The following
16111609
properties are supported:
1612-
* `concurrency` {number} The number of tests that can be run at the same time.
1610+
* `concurrency` {number|boolean|null} If a number is provided,
1611+
then that many tests would run in parallel.
1612+
If `true`, it would run all subtests in parallel.
1613+
If `false`, it would only run one test at a time.
16131614
If unspecified, subtests inherit this value from their parent.
1614-
**Default:** `1`.
1615+
**Default:** `null`.
16151616
* `only` {boolean} If truthy, and the test context is configured to run
16161617
`only` tests, then this test will be run. Otherwise, the test is skipped.
16171618
**Default:** `false`.

0 commit comments

Comments
 (0)