diff --git a/docs/config/index.md b/docs/config/index.md index fa2d2b3d2fc0..8a62a620bdd2 100644 --- a/docs/config/index.md +++ b/docs/config/index.md @@ -305,12 +305,7 @@ Custom reporter for output. Can contain one or more built-in report names, repor #### benchmark.outputFile -- **Type:** `string | Record` - -Write benchmark results to a file when the `--reporter=json` option is also specified. -By providing an object instead of a string you can define individual outputs when using multiple reporters. - -To provide object via CLI command, use the following syntax: `--outputFile.json=./path --outputFile.junit=./other-path`. +Deprecated in favor of `benchmark.outputJson`. #### benchmark.outputJson {#benchmark-outputJson} diff --git a/packages/vitest/src/node/types/benchmark.ts b/packages/vitest/src/node/types/benchmark.ts index 46796b8f4657..8d88ca2cca32 100644 --- a/packages/vitest/src/node/types/benchmark.ts +++ b/packages/vitest/src/node/types/benchmark.ts @@ -33,8 +33,7 @@ export interface BenchmarkUserOptions { reporters?: Arrayable /** - * Write test results to a file when the `--reporter=json` option is also specified. - * Also definable individually per reporter by using an object instead. + * @deprecated Use `benchmark.outputJson` instead */ outputFile?: | string