Skip to content

Commit c6b4cca

Browse files
committed
docs: add ts config
1 parent 3cda38d commit c6b4cca

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,14 @@ See [index.d.ts](https://github.com/oxc-project/oxc-resolver/blob/main/napi/inde
187187
| roots | [] | A list of root paths |
188188
| symlinks | true | Whether to resolve symlinks to their symlinked location |
189189

190+
### TypeScript Configuration
191+
192+
| Field | Default | Description |
193+
|---------------------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
194+
| tsconfig | None | TypeScript related config for resolver |
195+
| tsconfig.configFile | | A relative path to the tsconfig file based on `cwd`, or an absolute path of tsconfig file. |
196+
| tsconfig.references | `[]` | - 'auto': inherits from TypeScript config <br/> - `string []`: relative path (based on directory of the referencing tsconfig file) or absolute path of referenced project's tsconfig |
197+
190198
### Unimplemented Options
191199

192200
| Field | Default | Description |

0 commit comments

Comments
 (0)