TypeScript 如何在 TypeScript 项目中导入 Node 模块 ERR_REQUIRE_ESM

在本文中，我们将介绍如何在 TypeScript 项目中导入 Node 模块 ERR_REQUIRE_ESM。ERR_REQUIRE_ESM是一个常见的错误，它指示在尝试导入没有默认导出的ES模块时发生了错误。我们将学习如何解决这个错误，并对实际的示例进行说明。

阅读更多：TypeScript 教程

什么是 ERR_REQUIRE_ESM 错误？

在理解如何解决 ERR_REQUIRE_ESM 错误之前，我们先来了解一下这个错误是如何发生的。当我们尝试在 TypeScript 项目中导入一个没有默认导出的 ES 模块时，会出现 ERR_REQUIRE_ESM 错误。这个错误通常发生在使用 CommonJS 的 require 语法导入 ES 模块时。

解决 ERR_REQUIRE_ESM 错误的方法

要解决 ERR_REQUIRE_ESM 错误，我们需要做以下几步：

1. 确保 Node 版本支持 ES 模块

首先，我们需要确认我们所使用的 Node 版本是否支持 ES 模块。从 Node 12 开始，Node 已经原生支持 ES 模块，不再需要额外的配置。如果你使用的是较旧版本的 Node，请考虑升级到最新版本。

2. 使用 ES 模块语法导入模块

在解决 ERR_REQUIRE_ESM 错误时，我们需要使用 ES 模块的语法来导入模块。ES 模块的导入语法使用 import 关键字，而不是 require。例如，如果我们想要导入一个名为 “example” 的模块，我们将使用以下语法：

import * as example from 'example';

此语法将整个模块导入到名为 “example” 的变量中。

3. 禁用 CommonJS 转换

为了确保我们的 TypeScript 项目能够正确解析 ES 模块，在 tsconfig.json 文件中，我们需要将 “module” 选项设置为 “esnext”，并将 “moduleResolution” 选项设置为 “node”。这将禁用 TypeScript 的 CommonJS 转换，并允许我们使用 ES 模块语法导入模块。

修改 tsconfig.json 文件如下：

{
  "compilerOptions": {
    "module": "esnext",
    "moduleResolution": "node",
    ...
  },
  ...
}

完成以上步骤后，我们应该能够成功地导入 Node 模块，解决 ERR_REQUIRE_ESM 错误。

示例

让我们通过一个示例来演示如何在 TypeScript 项目中解决 ERR_REQUIRE_ESM 错误。

假设我们有一个 TypeScript 项目，项目结构如下：

project/
├── src/
│   ├── app.ts
│   └── example.ts
└── tsconfig.json

在 “example.ts” 文件中，我们导出一个简单的函数：

export function greet(name: string) {
  console.log(`Hello, ${name}!`);
}

然后，在 “app.ts” 中，我们想要导入并使用 “greet” 函数，我们可以按照以下步骤进行操作：

在 “app.ts” 中，使用 ES 模块语法导入 “greet” 函数：

import { greet } from './example';

确保 “tsconfig.json” 中的 “module” 选项设置为 “esnext”，并将 “moduleResolution” 选项设置为 “node”。

修改 “tsconfig.json” 如下：

{
  "compilerOptions": {
    "module": "esnext",
    "moduleResolution": "node",
    ...
  },
  ...
}

在 “app.ts” 中，调用 “greet” 函数：

greet('TypeScript');

运行该项目，你将看到控制台输出了 “Hello, TypeScript!”。

通过以上示例，我们成功地解决了 ERR_REQUIRE_ESM 错误，并成功导入了 Node 模块。

总结

在本文中，我们介绍了如何在 TypeScript 项目中解决 ERR_REQUIRE_ESM 错误，并提供了详细的解决方法和示例。通过使用 ES 模块语法和适当的配置，我们可以成功导入没有默认导出的 ES 模块，并避免 ERR_REQUIRE_ESM 错误的发生。希望本文能对你在 TypeScript 项目中导入 Node 模块的过程有所帮助。