Skip to content

Commit 62b8f12

Browse files
committed
update readme
1 parent 36cda00 commit 62b8f12

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,11 @@ There is also short alias `tsnd` for running `ts-node-dev`:
3737
tsnd --respawn server.ts
3838
```
3939

40-
**Also there are additional options specific to `ts-node-dev`:**
4140

42-
- `--prefer-ts` (`--prefer-ts-exts`) - (default: false) - For each `.js` file (that is not in `node_modules`) will try to check if corresponding `.ts` version exists and require it.
41+
Look up flags and options can be used [in ts-node's docs](https://github.com/TypeStrong/ts-node#cli-and-programmatic-options).
42+
43+
44+
**Also there are additional options specific to `ts-node-dev`:**
4345

4446
- `--ignore-watch` - (default: []) - files/folders to be [ignored by `node-dev`](https://github.com/fgnass/node-dev#ignore-paths). **But also this behaviour enhanced:** it will also make up `new RegExp` of passed ignore string and check absolute paths of required files for match.
4547

@@ -56,7 +58,7 @@ tsnd --respawn server.ts
5658

5759
**Caveats and points of notice:**
5860

59-
- Especially for large code bases always consider running with `--transpileOnly` flag which is normal for dev workflow and will speed up things greatly. Note, that `ts-node-dev` will not put watch handlers on TS files that contain only types/interfaces (used only for type checking) - this is current limitation by design.
61+
- Especially for large code bases always consider running with `--transpile-only` flag which is normal for dev workflow and will speed up things greatly. Note, that `ts-node-dev` will not put watch handlers on TS files that contain only types/interfaces (used only for type checking) - this is current limitation by design.
6062

6163
- `--ignore-watch` will NOT affect files ignored by TS compilation. Use `--ignore` option (or `TS_NODE_IGNORE` env variable) to pass **RegExp strings** for filtering files that should not be compiled, by default `/node_modules/` are ignored.
6264

@@ -68,10 +70,6 @@ tsnd --respawn server.ts
6870

6971
- The good thing is that `ts-node-dev` watches used `tsconfig.json` file, and will reinitialize compilation on its change, but you have to restart the process manually when you update used version of `typescript` or make any other changes that may effect compilation results.
7072

71-
## Support
72-
73-
Support the project with a donation and help us to give it back. [[Become a backer](https://opencollective.com/ts-node-dev#backer)]
74-
7573
## License
7674

7775
WTF.

0 commit comments

Comments
 (0)