Skip to content

Commit b4c349d

Browse files
committed
Improve docs
1 parent af12fd0 commit b4c349d

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Options passed to formatters (currently only `codeframe` - see [available option
9393
If `true`, logger will not be used. Default: `false`.
9494

9595
* **checkSyntacticErrors** `boolean`:
96-
If you're using the plugin with [HappyPack](https://github.com/amireh/happypack) or [thread-loader](https://github.com/webpack-contrib/thread-loader) then syntactic errors cannot be raised by ts-loader. In this case you would want the plugin to report syntactic errors as well. Default: `false`.
96+
This option is useful if you're using ts-loader in `happyPackMode` with [HappyPack](https://github.com/amireh/happypack) or [thread-loader](https://github.com/webpack-contrib/thread-loader) to parallelise your builds. It will ensure that the plugin checks for both syntactic errors (eg `const array = [{} {}];`) and semantic errors (eg `const x: number = '1';`). By default the plugin only checks for semantic errors. This is because when ts-loader is used in `transpileOnly` mode, ts-loader will still report syntactic errors. When used in `happyPackMode` it does not. Default: `false`.
9797

9898
* **memoryLimit** `number`:
9999
Memory limit for service process in MB. If service exits with allocation failed error, increase this number. Default: `2048`.

0 commit comments

Comments
 (0)