Skip to content

Commit

Permalink
Note type check features failing at runtime (#555)
Browse files Browse the repository at this point in the history
  • Loading branch information
blakeembrey committed Mar 17, 2018
1 parent 6ea624b commit 5ebd393
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Expand Up @@ -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

Expand All @@ -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

Expand Down

0 comments on commit 5ebd393

Please sign in to comment.