website·Indexed 36 days ago
https://typestrong.org/ts-node/TypeScript execution engine for Node.js that allows running TypeScript files directly. Features include a TypeScript REPL, support for CommonJS and native ECMAScript modules, built-in SWC support via the --swc flag, and a comprehensive API for compiling TypeScript to JavaScript.
TSCommon interface provides a set of common TypeScript interfaces and API declarations used by ts-node. This layer allows ts-node to maintain compatibility between different TypeScript versions. Specifically, it explicitly declares public APIs from typescript@next that may not yet be available in typescript@latest, ensuring that ts-node can utilize newer features while remaining stable.TSError class extends BaseError and is used to represent errors originating from TypeScript diagnostics. It provides detailed information about the diagnostic codes and the associated diagnostic objects.// Example instantiation of TSError
const error = new TSError(
"Unexpected token",
[123],
[diagnosticObject]
);TypeInfo interface provides information retrieved from a type info check. It contains basic metadata about the type, specifically the name of the type and any associated comments.interface TypeInfo {
comment: string;
name: string;
}.ts, .tsx, .js, and .jsx extensions. When Node.js attempts to load these files, ts-node intercepts the process, transforms the TypeScript code into JavaScript based on the settings in the project's tsconfig.json (mimicking tsc compilation), and passes the resulting JavaScript to the Node.js engine for execution. Additionally, ts-node registers hooks to handle sourcemap application for stack traces and to remap .js imports back to their corresponding .ts source files.tslib and Node.js type definitions (@types/node) as development dependencies.npm install -D tslib @types/nodecreate. This export must be of type TranspilerModule, which contains a create property that returns a TranspilerFactory.// Example of a TranspilerModule implementation
export const create = () => {
// Return a TranspilerFactory implementation
};ReplService to a ts-node compiler service using the setService method.replService.setService(service: Service): voidcreate function conforming to the TranspilerModule interface. ts-node invokes this create function at startup to instantiate one or more transpiler instances responsible for transforming TypeScript into JavaScript.typescript and ts-node globally on your system to make them available across all projects.npm install -g typescript
npm install -g ts-nodets-node as the interpreter for a script, use the #!/usr/bin/env ts-node shebang. For maximum portability, define options in tsconfig.json rather than the shebang itself. If you must include options in the shebang, use the env -S flag (supported on recent versions of env on Mac and Linux).#!/usr/bin/env ts-node
// Options are read from tsconfig.json
console.log("Hello, world!");#!/usr/bin/env -S ts-node --files
// This shebang works on Mac and Linux with newer versions of env