Skip to content

Commit 3769b21

Browse files
Update packages/plugin-typescript/README.md
Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>
1 parent d1451b5 commit 3769b21

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

packages/plugin-typescript/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,15 +89,14 @@ The plugin accepts the following parameters:
8989
| tsConfigPath | string | `tsconfig.json` | A string that defines the path to your `tsconfig.json` file |
9090
| onlyAudits | string[] | undefined | An array of audit slugs to specify which documentation types you want to measure. Only the specified audits will be included in the results |
9191

92-
#### TsConfigPath
92+
#### `tsconfig`
9393

94-
Optional parameter. The `tsConfigPath` option accepts a string that defines the path to your config file and defaults to `tsconfig.json`.
94+
Optional parameter. The `tsconfig` option accepts a string that defines the path to your config file and defaults to `tsconfig.json`.
9595

9696
```js
97-
typescriptPlugin({
98-
tsConfigPath: './tsconfig.json',
97+
await typescriptPlugin({
98+
tsconfig: './tsconfig.json',
9999
});
100-
```
101100

102101
#### OnlyAudits
103102

0 commit comments

Comments
 (0)