Skip to content

Commit

Permalink
doc: update test concurrency description / default values
Browse files Browse the repository at this point in the history
  • Loading branch information
richiemccoll committed Feb 5, 2023
1 parent 03854f6 commit 1f61d56
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions doc/api/test.md
Expand Up @@ -678,11 +678,9 @@ added:
properties are supported:
* `concurrency` {number|boolean} If a number is provided,
then that many files would run in parallel.
If truthy, it would run (number of cpu cores - 1)
files in parallel.
If falsy, it would only run one file at a time.
If unspecified, subtests inherit this value from their parent.
**Default:** `true`.
If `true`, it would run `os.availableParallelism() - 1` test files in parallel.
If `false`, it would only run one test file at a time.
**Default:** `false`.
* `files`: {Array} An array containing the list of files to run.
**Default** matching files from [test runner execution model][].
* `signal` {AbortSignal} Allows aborting an in-progress test execution.
Expand Down Expand Up @@ -728,10 +726,9 @@ changes:
properties are supported:
* `concurrency` {number|boolean} If a number is provided,
then that many tests would run in parallel.
If truthy, it would run (number of cpu cores - 1)
tests in parallel.
If `true`, it would run `os.availableParallelism() - 1` tests in parallel.
For subtests, it will be `Infinity` tests in parallel.
If falsy, it would only run one test at a time.
If `false`, it would only run one test at a time.
If unspecified, subtests inherit this value from their parent.
**Default:** `false`.
* `only` {boolean} If truthy, and the test context is configured to run
Expand Down Expand Up @@ -1645,9 +1642,12 @@ changes:
`fn` does not have a name.
* `options` {Object} Configuration options for the subtest. The following
properties are supported:
* `concurrency` {number} The number of tests that can be run at the same time.
* `concurrency` {number|boolean|null} If a number is provided,
then that many tests would run in parallel.
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.
**Default:** `1`.
**Default:** `null`.
* `only` {boolean} If truthy, and the test context is configured to run
`only` tests, then this test will be run. Otherwise, the test is skipped.
**Default:** `false`.
Expand Down

0 comments on commit 1f61d56

Please sign in to comment.