On this page

稳定性:2 - 稳定

在 Node.js 中启用运行时 TypeScript 支持有两种方式:

  1. 为了获得所有 TypeScript 语法和功能的 完整支持,包括使用任何版本的 TypeScript,请使用第三方包。

  2. 为了获得轻量级支持,你可以使用内置的 类型剥离 支持。

要使用支持所有 TypeScript 功能(包括 tsconfig.json)的 TypeScript,你可以使用第三方包。这些说明使用 tsx 作为示例,但还有许多其他类似的库可用。

  1. 使用项目所用的任何包管理器将该包安装为开发依赖。例如,使用 npm

  2. 然后你可以通过以下方式运行 TypeScript 代码:

    或者,你也可以通过 node 运行:

默认情况下,Node.js 将执行仅包含可擦除 TypeScript 语法的 TypeScript 文件。 Node.js 会将 TypeScript 语法替换为空白字符,且不执行类型检查。 要禁用此功能,请使用 --no-strip-types 标志。

Node.js 忽略 tsconfig.json 文件,因此依赖 tsconfig.json 内设置的功能,如路径或将较新的 JavaScript 语法转换为较旧的标准,故意不予支持。要获得完整 TypeScript 支持,请参阅 完整 TypeScript 支持

类型剥离功能旨在轻量级。 通过故意不支持需要生成 JavaScript 代码的语法,并用空白字符替换内联类型,Node.js 可以在不需要源代码映射的情况下运行 TypeScript 代码。

类型剥离兼容大多数版本的 TypeScript,但我们建议使用 5.8 或更新版本,并配合以下 tsconfig.json 设置:

{
  "compilerOptions": {
     "noEmit": true, // 可选 - 见下方注释
     "target": "esnext",
     "module": "nodenext",
     "rewriteRelativeImportExtensions": true,
     "erasableSyntaxOnly": true,
     "verbatimModuleSyntax": true
  }
}

如果你打算仅执行 *.ts 文件(例如构建脚本),请使用 noEmit 选项。如果你打算分发 *.js 文件,则不需要此标志。

  • .ts 文件的模块系统确定方式 .js 文件相同。 要使用 importexport 语法,请将 "type": "module" 添加到最近的父级 package.json 中。
  • .mts 文件将始终作为 ES 模块运行,类似于 .mjs 文件。
  • .cts 文件将始终作为 CommonJS 模块运行,类似于 .cjs 文件。
  • 不支持 .tsx 文件。

与 JavaScript 文件一样,import 语句和 import() 表达式中 文件扩展名是必需的import './file.ts',而不是 import './file'。出于向后兼容性考虑,require() 调用中文件扩展名也是必需的:require('./file.ts'),而不是 require('./file'),类似于 CommonJS 文件中 require 调用中 .cjs 扩展名是必需的方式。

tsconfig.json 选项 allowImportingTsExtensions 将允许 TypeScript 编译器 tsc 对包含 .ts 扩展名的 import 说明符的文件进行类型检查。

最需要转换的显著功能包括:

  • Enum 声明
  • 带有运行时代码的 namespace
  • 参数属性
  • 导入别名

不包含运行时代码的 namespace 是受支持的。 此示例将正常工作:

// 此命名空间正在导出一个类型
namespace TypeOnly {
   export type A = string;
}

这将导致 ERR_UNSUPPORTED_TYPESCRIPT_SYNTAX 错误:

// 此命名空间正在导出一个值
namespace A {
   export let x = 1
}

由于装饰器目前是 TC39 Stage 3 提案,它们不会被转换并将导致解析器错误。 Node.js 不提供 polyfill,因此直到 JavaScript 原生支持装饰器之前,都不会支持装饰器。

此外,Node.js 不读取 tsconfig.json 文件,也不支持依赖 tsconfig.json 内设置的功能,如路径或将较新的 JavaScript 语法转换为较旧的标准。

此示例将正常工作:

import type { Type1, Type2 } from './module.ts';
import { fn, type FnParams } from './fn.ts';

这将导致运行时错误:

import { Type1, Type2 } from './module.ts';
import { fn, FnParams } from './fn.ts';

REPL、--checkinspect 中不支持 TypeScript 语法。