Skip to content

Commit 486fd11

Browse files
authored
fix(types): mark pool options as not available in project config (#5934)
1 parent 3a96a3d commit 486fd11

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

docs/config/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -900,7 +900,7 @@ Pass additional arguments to `node` process in the VM context. See [Command-line
900900
Be careful when using, it as some options may crash worker, e.g. --prof, --title. See https://github.com/nodejs/node/issues/41103.
901901
:::
902902

903-
### fileParallelism {#fileparallelism}
903+
### fileParallelism<NonProjectOption /> {#fileparallelism}
904904

905905
- **Type:** `boolean`
906906
- **Default:** `true`
@@ -912,13 +912,13 @@ Should all test files run in parallel. Setting this to `false` will override `ma
912912
This option doesn't affect tests running in the same file. If you want to run those in parallel, use `concurrent` option on [describe](/api/#describe-concurrent) or via [a config](#sequence-concurrent).
913913
:::
914914

915-
### maxWorkers {#maxworkers}
915+
### maxWorkers<NonProjectOption /> {#maxworkers}
916916

917917
- **Type:** `number`
918918

919919
Maximum number of workers to run tests in. `poolOptions.{threads,vmThreads}.maxThreads`/`poolOptions.forks.maxForks` has higher priority.
920920

921-
### minWorkers {#minworkers}
921+
### minWorkers<NonProjectOption /> {#minworkers}
922922

923923
- **Type:** `number`
924924

packages/vitest/src/types/config.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1041,6 +1041,9 @@ export type ProjectConfig = Omit<
10411041
| 'inspectBrk'
10421042
| 'deps'
10431043
| 'coverage'
1044+
| 'maxWorkers'
1045+
| 'minWorkers'
1046+
| 'fileParallelism'
10441047
> & {
10451048
sequencer?: Omit<SequenceOptions, 'sequencer' | 'seed'>
10461049
deps?: Omit<DepsOptions, 'moduleDirectories'>

0 commit comments

Comments
 (0)