From 85910bb7ed34d6adff0a54cbcc1140e5bcabe336 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 value --- doc/api/test.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/api/test.md b/doc/api/test.md index 2dfc05e03cdeec..1f758ef3105a1e 100644 --- a/doc/api/test.md +++ b/doc/api/test.md @@ -733,7 +733,7 @@ changes: For subtests, it will be `Infinity` tests in parallel. If falsy, it would only run one test at a time. If unspecified, subtests inherit this value from their parent. - **Default:** `false`. + **Default:** `1`. * `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`. @@ -1645,7 +1645,11 @@ 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} 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:** `1`. * `only` {boolean} If truthy, and the test context is configured to run