From 375bb22df99e223c77b28ea7ea99447123e38925 Mon Sep 17 00:00:00 2001 From: richiemccoll Date: Tue, 31 Jan 2023 18:50:59 +0200 Subject: [PATCH] doc: update test concurrency description / default values PR-URL: https://github.com/nodejs/node/pull/46457 Reviewed-By: Moshe Atlow Reviewed-By: Luigi Pinca Reviewed-By: Jacob Smith --- doc/api/test.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/doc/api/test.md b/doc/api/test.md index 7a6d85fb483676..d93d0723297bdc 100644 --- a/doc/api/test.md +++ b/doc/api/test.md @@ -674,11 +674,10 @@ added: v18.9.0 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. @@ -724,10 +723,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 @@ -1609,9 +1607,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`.