Skip to content

Commit 0210c43

Browse files
committed
doc: update test concurrency description / default value
1 parent 190fb59 commit 0210c43

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

doc/api/test.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -728,12 +728,12 @@ changes:
728728
properties are supported:
729729
* `concurrency` {number|boolean} If a number is provided,
730730
then that many tests would run in parallel.
731-
If truthy, it would run (number of cpu cores - 1)
731+
If `true`, it would run `os.availableParallelism() - 1` files in parallel.
732732
tests in parallel.
733733
For subtests, it will be `Infinity` tests in parallel.
734-
If falsy, it would only run one test at a time.
734+
If `false`, it would only run one file at a time.
735735
If unspecified, subtests inherit this value from their parent.
736-
**Default:** `false`.
736+
**Default:** `1`.
737737
* `only` {boolean} If truthy, and the test context is configured to run
738738
`only` tests, then this test will be run. Otherwise, the test is skipped.
739739
**Default:** `false`.
@@ -1645,7 +1645,11 @@ changes:
16451645
`fn` does not have a name.
16461646
* `options` {Object} Configuration options for the subtest. The following
16471647
properties are supported:
1648-
* `concurrency` {number} The number of tests that can be run at the same time.
1648+
* `concurrency` {number|boolean} If a number is provided,
1649+
then that many files would run in parallel.
1650+
If `true`, it would run `os.availableParallelism() - 1` files in parallel.
1651+
files in parallel.
1652+
If `false`, it would only run one file at a time.
16491653
If unspecified, subtests inherit this value from their parent.
16501654
**Default:** `1`.
16511655
* `only` {boolean} If truthy, and the test context is configured to run

0 commit comments

Comments
 (0)