ts-node

TypeScript execution and REPL for node.js

Runtime
TypeStrong/ts-nodetypestrong.org/ts-nodets-node

README

TypeScript Node


TypeScript execution and REPL for node.js, with source map support. Works with typescript@>=2.7.


Experimental ESM support


Native ESM support is currently experimental. For usage, limitations, and to provide feedback, see #1007.

Installation


  1. ```sh
  2. # Locally in your project.
  3. npm install -D typescript
  4. npm install -D ts-node

  6. # Or globally with TypeScript.
  7. npm install -g typescript
  8. npm install -g ts-node
  9. ```

Tip: Installing modules locally allows you to control and share the versions through package.json. TS Node will always resolve the compiler from cwd before checking relative to its own installation.

Usage


Shell


  1. ```sh
  2. # Execute a script as `node` + `tsc`.
  3. ts-node script.ts

  5. # Starts a TypeScript REPL.
  6. ts-node

  8. # Execute code with TypeScript.
  9. ts-node -e 'console.log("Hello, world!")'

  11. # Execute, and print, code with TypeScript.
  12. ts-node -p -e '"Hello, world!"'

  14. # Pipe scripts to execute with TypeScript.
  15. echo 'console.log("Hello, world!")' | ts-node

  17. # Equivalent to ts-node --cwd-mode
  18. ts-node-cwd scripts.ts

  20. # Equivalent to ts-node --transpile-only
  21. ts-node-transpile-only scripts.ts
  22. ```

TypeScript REPL

Shebang


  1. ```typescript
  2. #!/usr/bin/env ts-node

  4. console.log("Hello, world!")
  5. ```

Passing CLI arguments via shebang is allowed on Mac but not Linux.  For example, the following will fail on Linux:

  1. ```
  2. #!/usr/bin/env ts-node --transpile-only --files
  3. // This shebang is not portable.  It only works on Mac
  4. ```

Programmatic


You can require ts-node and register the loader for future requires by using `require('ts-node').register({ / options / }). You can also use file shortcuts - node -r ts-node/register or node -r ts-node/register/transpile-only` - depending on your preferences.

Note: If you need to use advanced node.js CLI arguments (e.g. --inspect), use them with node -r ts-node/register instead of the ts-node CLI.

Developers


TS Node exports a create() function that can be used to initialize a TypeScript compiler that isn't registered to require.extensions, and it uses the same code as register.

Mocha


Mocha 6

  1. ```sh
  2. mocha --require ts-node/register --watch-extensions ts,tsx "test/**/*.{ts,tsx}" [...args]
  3. ```

Note: --watch-extensions is only used in --watch mode.

Mocha 7

  1. ```sh
  2. mocha --require ts-node/register --extensions ts,tsx --watch --watch-files src 'tests/**/*.{ts,tsx}' [...args]
  3. ```

Tape


  1. ```sh
  2. ts-node node_modules/tape/bin/tape [...args]
  3. ```

Gulp


  1. ```sh
  2. # Create a `gulpfile.ts` and run `gulp`.
  3. gulp
  4. ```