Skip to content
This repository was archived by the owner on Dec 1, 2019. It is now read-only.

Commit 44baa68

Browse files
author
Stanislav Panferov
committed
docs(README): update readme
1 parent 31bfa0f commit 44baa68

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ Thanks @andreypopp for the great project.
88
The main goal of this loader is to support the **watch** mode and *webpack-dev-server* with **incremental** compilation.
99
Also there are a lot of problems in other TypeScript loaders that were fixed here.
1010

11-
## Unstable TypeScript warning
12-
13-
Right now this library works only with the **TypeScript 1.5-beta** compiler or with *ntypescript*.
14-
1511
## Installation
1612

1713
```
@@ -53,7 +49,6 @@ After that, you would be able to build TypeScript files with webpack.
5349
## TS defaults
5450

5551
* target = 'es5'
56-
* module = 'commonjs'
5752

5853
## tsconfig.json
5954

@@ -71,12 +66,14 @@ You can use .tsconfig.json file to configure your compiler and loader:
7166
}
7267
```
7368

74-
## Loader Options
69+
## Loader options
7570

7671
### compiler *(string) (default='typescript')*
7772

7873
Allows use of TypeScript compilers other than the official one. Should be
7974
set to the NPM name of the compiler, e.g. *ntypescript* or path to a `tsc` file.
75+
Note that the compiler must be installed in **your** project. You can also use
76+
nightly versions.
8077

8178
### emitRequireType *(boolean) (default=true)*
8279

@@ -117,12 +114,16 @@ Use this setting to disable type checking if you want.
117114

118115
### forkChecker *(string) (default=false)*
119116

120-
Do type checking in a separate process, so webpack don't need to wait. **Significantly** improves development workflow.
117+
Do type checking in a separate process, so webpack don't need to wait. **Significantly** improves development workflow with tools like [react-hot-loader](https://github.com/gaearon/react-hot-loader).
118+
119+
## Compiler options
120+
121+
You can pass compiler options inside loader query string or in tsconfig file.
121122

122123
## Using with --watch or webpack-dev-server
123124

124125
This loader has support of both `--watch` and `webpack-dev-server` modes. It handles file dependencies
125-
using internal webpack dependency markers. When you change a file, the loader recompiles all dependencies.
126+
using internal webpack dependency markers. When you change a file, the loader recompiles all the dependencies.
126127

127128
## External Modules
128129

@@ -133,7 +134,7 @@ npm install --save react
133134
```
134135

135136
```typescript
136-
import React = require('react');
137+
import * as React from 'react';
137138
```
138139

139140
## Internal Modules

0 commit comments

Comments
 (0)