Skip to content

Commit 721986e

Browse files
committed
docs(readme): document options
1 parent 8803aee commit 721986e

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,23 @@ with node's implementation of ES Modules.
8787
If you set `resolve.fullySpecified` you should also delete the
8888
`resolve.extensions` option, if any.
8989

90+
## Options
91+
92+
Pass options to the plugin as an argument to the constructor, as follows:
93+
94+
```js
95+
new ResolveTypeScriptPlugin({
96+
includeNodeModules: false
97+
});
98+
```
99+
100+
### includeNodeModules
101+
102+
By default, the plugin does not resolve TypeScript files inside `node_modules`
103+
subdirectories. To enable this, set `includeNodeModules: true`.
104+
105+
Default: `false`.
106+
90107
## Feedback
91108

92109
We're seeking [community feedback][5] on this plugin.

0 commit comments

Comments
 (0)