TypeScript execution and REPL for node. Works with
typescript@>=2.0.
npm install -g ts-node
npm install -g typescript- Execute TypeScript files with node
- Interactive REPL
- Execute (and print) TypeScript through the CLI
- Source map support
- Loads compiler options from
tsconfig.json
# Execute a script as `node` + `tsc`.
ts-node script.ts
# Starts a 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-nodeYou 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.
mocha --require ts-node/register --watch-extensions ts,tsx "test/**/*.{ts,tsx}" [...args]Note: --watch-extensions is only used in --watch mode.
ts-node node_modules/tape/bin/tape [...args]# Create a `gulpfile.ts` and run `gulp`.
gulpCreate a new node.js configuration, add -r ts-node/register to node args and move the program to the args list (so VS Code doesn't look for outFiles).
{
"type": "node",
"request": "launch",
"name": "Launch Program",
"runtimeArgs": [
"-r",
"ts-node/register"
],
"args": [
"${workspaceFolder}/index.ts"
]
}TypeScript Node works by registering the TypeScript compiler for .tsx? and .jsx? extension (when allowJs == true). When node.js has an extension registered (via require.extensions), it will use the extension internally for module resolution. When an extension is unknown to node.js, it handles the file as .js (JavaScript).
P.S. This means if you don't register an extension, it is compiled as JavaScript. When ts-node is used with allowJs, JavaScript files are transpiled using the TypeScript compiler.
Typescript Node loads tsconfig.json automatically. Use --skip-project to the loading tsconfig.json.
Tip: You can use ts-node together with tsconfig-paths to load modules according to the paths section in tsconfig.json.
You can set options by passing them before the script path, via programmatic usage or via environment variables.
ts-node --compiler ntypescript --project src/tsconfig.json hello-world.tsSupports --print, --eval and --require from node.js CLI options.
--helpPrints help text--versionPrints version information
Environment variable denoted in parentheses.
--transpileOnlyUse TypeScript's fastertranspileModule(TS_NODE_TRANSPILE_ONLY)--cacheDirectoryConfigure the output file cache directory (TS_NODE_CACHE_DIRECTORY)-I, --ignore [pattern]Override the path patterns to skip compilation (TS_NODE_IGNORE)-P, --project [path]Path to TypeScript JSON project file (TS_NODE_PROJECT)-C, --compiler [name]Specify a custom TypeScript compiler (TS_NODE_COMPILER)-D, --ignoreDiagnostics [code]Ignore TypeScript warnings by diagnostic code (TS_NODE_IGNORE_DIAGNOSTICS)-O, --compilerOptions [opts]JSON object to merge with compiler options (TS_NODE_COMPILER_OPTIONS)--no-cacheDisable the local TypeScript Node cache (TS_NODE_CACHE)--skip-projectSkip project config resolution and loading (TS_NODE_SKIP_PROJECT)--skip-ignoreSkip ignore checks (TS_NODE_SKIP_IGNORE)
transformersAn array of transformers to pass to TypeScriptreadFileCustom TypeScript-compatible file reading functionfileExistsCustom TypeScript-compatible file existence function
TypeScript Node compiles source code via require(), watching files and code reloads are out of scope for the project. If you want to restart the ts-node process on file change, existing node.js tools such as nodemon, onchange and node-dev work.
There's also ts-node-dev, a modified version of node-dev using ts-node for compilation and won't restart the process on file change.
MIT
