Skip to content

IncrementalCommunity/ts-node

This branch is 460 commits behind TypeStrong/ts-node:master.

Folders and files

NameName
Last commit message
Last commit date
Nov 2, 2015
Apr 13, 2016
Jul 15, 2015
Jul 15, 2015
Nov 2, 2015
Mar 13, 2016
Jul 15, 2015
Mar 23, 2016
Apr 19, 2016
Jul 15, 2015
Sep 22, 2015
Mar 13, 2016
Dec 22, 2015
Mar 13, 2016

Repository files navigation

TypeScript Node

NPM version NPM downloads Build status Test coverage

TypeScript execution environment and REPL for node. Works with typescript@>=1.5.

Installation

npm install -g ts-node

# Install a TypeScript compiler (requires `typescript` by default).
npm install -g typescript

Features

  • Execute TypeScript files with node
  • Interactive REPL
  • Execute (and print) TypeScript through the CLI
  • Uses source maps
  • Loads from tsconfig.json

Usage

# Execute a script as you world normally with `node`.
ts-node script.ts

# Starts the TypeScript REPL.
ts-node

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

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

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

TypeScript REPL

Mocha

mocha --require ts-node/register [...args]

Tape

ts-node node_modules/tape/bin/tape [...args]

Gulp

# Just create a `gulpfile.ts` and run `gulp`.
gulp

Loading tsconfig.json

Typescript Node uses tsconfig.json automatically, use -n to skip loading tsconfig.json.

Configuration Options

You can set options by passing them in before the script.

ts-node --compiler ntypescript --project src --ignoreWarnings 2304 hello-world.ts
  • --project, -P Location to resolve tsconfig.json from (also process.env.TS_NODE_PROJECT)
  • --noProject, -n Disable loading tsconfig.json (also process.env.TS_NODE_NO_PROJECT)
  • --compiler, -c Use a custom, require-able TypeScript compiler compatible with typescript@>=1.5.0-alpha (also process.env.TS_NODE_COMPILER)
  • --ignoreWarnings, -i Set an array of TypeScript diagnostic codes to ignore (also process.env.TS_NODE_IGNORE_WARNINGS)
  • --disableWarnings, -d Ignore all TypeScript errors (also process.env.TS_NODE_DISABLE_WARNINGS)

Programmatic Usage

require('ts-node').register({ /* options */ })

// Or using the shortcut file.
require('ts-node/register')

License

MIT

About

TypeScript execution environment for node

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 64.6%
  • JavaScript 35.4%