From 5ebd3934907fab03420bdd4408cbd51e5bb0efcb Mon Sep 17 00:00:00 2001 From: Blake Embrey Date: Sat, 17 Mar 2018 11:48:48 -0700 Subject: [PATCH] Note type check features failing at runtime (#555) --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3edd369c1..9beee36f9 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![Build status][travis-image]][travis-url] [![Test coverage][coveralls-image]][coveralls-url] -> TypeScript execution environment and REPL for node. **Works with `typescript@>=2.0`**. +> TypeScript execution and REPL for node. **Works with `typescript@>=2.0`**. ## Installation @@ -22,7 +22,9 @@ npm install -g typescript * Interactive REPL * Execute (and print) TypeScript through the CLI * Source map support -* Loads compiler options and `.d.ts` files from `tsconfig.json` +* Loads compiler options from `tsconfig.json` + +**Important:** The default mode of `ts-node` is transpile _without_ type checking. This can cause problems where type information is required to generate a valid JavaScript program. Two known examples of this are `const enum` and import elision of type files used in valid runtime positions. If you require these features, ensure you enable type checking. ## Usage