Skip to content

Commit ed92e3d

Browse files
authored
Merge pull request TypeStrong#103 from johnnyreilly/master
DOCS update: how to use overlay with webpack-dev-server
2 parents f98859c + 89da7c8 commit ed92e3d

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ Path to *tslint.json* file or `true`. If `true`, uses `path.resolve(compiler.opt
6767
Directories or files to watch by service. Not necessary but improves performance (reduces number of `fs.stat` calls).
6868

6969
* **async** `boolean`:
70-
True by default - `async: false` can block webpack's emit to wait for type checker/linter and to add errors to the webpack's compilation.
71-
We recommend to use it in projects where type checking is faster than webpack's build - it's better for integration with other plugins.
70+
True by default - `async: false` can block webpack's emit to wait for type checker/linter and to add errors to the webpack's compilation.`
71+
We recommend to set this to `false` in projects where type checking is faster than webpack's build - it's better for integration with other plugins. Another scenario where you might want to set this to `false` is if you use the `overlay` functionality of `webpack-dev-server`.
7272

7373
* **ignoreDiagnostics** `number[]`:
7474
List of typescript diagnostic codes to ignore.

0 commit comments

Comments
 (0)