深入理解ESM：解决JavaScript模块导入“未提供导出”错误

模块导入错误解析：SyntaxError: The requested module 'X' does not provide an export named 'Y'

在现代JavaScript开发中，ES Modules (ESM) 已成为组织和复用代码的标准方式。然而，开发者在使用import语句时，常会遇到SyntaxError: The requested module 'X' does not provide an export named 'Y'这类错误。这通常意味着你尝试以某种方式导入模块，但该模块并未以你期望的方式提供相应的导出。

以ipfs模块为例，当尝试使用以下代码导入时：

import IPFS from 'ipfs' // 尝试默认导入
// ... IPFS.create() ...

系统会抛出错误：SyntaxError: The requested module 'ipfs' does not provide an export named 'default'。这明确指出ipfs模块没有提供一个默认导出。

随后，如果根据IDE的类型提示（如TypeScript的.d.ts文件）尝试命名导入：

立即学习“Java免费学习笔记（深入）”；

import {IPFS} from 'ipfs' // 尝试命名导入IPFS
// ... IPFS.create() ...

又会遇到另一个错误：SyntaxError: The requested module 'ipfs' does not provide an export named 'IPFS'。这似乎与类型定义文件中的export type IPFS = ...相矛盾。

错误根源：TypeScript类型与JavaScript运行时导出的差异

问题的核心在于对JavaScript模块导出机制的理解，以及区分TypeScript类型定义与实际JavaScript运行时导出的重要性。

1. 默认导出 (Default Export) 与命名导出 (Named Export)

   • 默认导出：一个模块只能有一个默认导出，通过export default someValue声明，并使用import someName from 'module'导入。
   • 命名导出：一个模块可以有多个命名导出，通过export const someName = someValue或export { someName }声明，并使用import { someName } from 'module'导入。

2. TypeScript类型定义 (.d.ts) 的作用

   • .d.ts文件是TypeScript用来描述JavaScript模块结构和类型信息的。其中的export type IPFS = import('ipfs-core-types').IPFS;语句定义了一个名为IPFS的类型别名，它只在TypeScript编译时提供类型检查，对JavaScript运行时没有任何影响。JavaScript引擎在执行代码时，不会“看到”或使用这些类型定义。
   • 因此，即使index.d.ts中存在export type IPFS，也不意味着JavaScript模块实际导出了一个名为IPFS的值。

通过查看ipfs模块的index.d.ts文件（或其对应的JavaScript源码），我们可以发现它导出了如create、crypto、isIPFS等命名值，但没有默认导出，也没有一个名为IPFS的运行时值导出。

// 简化后的 ipfs/index.d.ts 示例
export const create: typeof import("ipfs-core/src/components").create;
// ... 其他命名导出 ...
export type IPFS = import('ipfs-core-types').IPFS; // 这是一个类型定义

这里清晰地表明create是一个可导出的值，而IPFS仅仅是一个类型。

文心大模型

百度飞桨-文心大模型 ERNIE 3.0 文本理解与创作

56

查看详情

解决方案

针对上述问题，有两种主要且有效的解决方案，它们都基于正确理解模块的命名导出。

方案一：直接导入所需的命名导出

如果你的代码只需要模块中的特定功能（例如，ipfs模块的create函数），你可以直接导入它。

import { create } from 'ipfs'; // 直接导入命名导出 'create'
import OrbitDB from 'orbit-db';

;(async function () {
  const ipfs = await create(); // 使用导入的 create 函数
  const orbitdb = await OrbitDB.createInstance(ipfs);

  // ... 你的其他逻辑 ...
})()

这种方式的优点是代码清晰，只导入了实际需要的部分，有助于减少打包体积。缺点是如果你的原始代码习惯于通过一个统一的IPFS对象来访问其内部方法（如IPFS.create()），那么你需要修改所有调用点。

方案二：使用命名空间导入 (import * as)

import * as name from 'module'语法会将模块的所有命名导出收集到一个对象中，并将其赋值给指定的name变量。这样，你可以通过name.exportName的方式访问模块的各项功能。这对于保持原有代码结构（如IPFS.create()）非常有用。

import * as IPFS from 'ipfs'; // 导入所有命名导出到一个名为 IPFS 的对象
import OrbitDB from 'orbit-db';

;(async function () {
  const ipfs = await IPFS.create(); // 通过 IPFS 对象访问 create 方法
  const orbitdb = await OrbitDB.createInstance(ipfs);

  // Create / Open a database
  const db = await orbitdb.log("hello");
  await db.load();

  // Listen for updates from peers
  db.events.on("replicated", address => {
    console.log(db.iterator({ limit: -1 }).collect());
  });

  // Add an entry
  const hash = await db.add("world");
  console.log(hash);

  // Query
  const result = db.iterator({ limit: -1 }).collect();
  console.log(JSON.stringify(result, null, 2));
})()

这种方法是解决原始问题的最直接且侵入性最小的方案，因为它允许你继续使用IPFS.create()这种调用模式。

运行环境配置注意事项

为了确保Node.js能够正确识别和执行ES模块语法，请确认你的package.json文件中包含"type": "module"配置：

{
  "name": "ipfs-test",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC",
  "type": "module" // 确保此行存在
}

如果没有此配置，Node.js可能会将.js文件默认为CommonJS模块，导致ESM的import/export语法报错。

总结

解决SyntaxError: The requested module 'X' does not provide an export named 'Y'的关键在于：

1. 区分默认导出与命名导出：了解模块是如何声明其导出的。
2. 理解TypeScript类型定义与JavaScript运行时导出的差异：.d.ts文件中的类型定义不等于实际的JavaScript值导出。
3. 根据实际导出方式选择正确的导入语法：
   • 如果模块有默认导出，使用import SomeName from 'module'。
   • 如果模块有命名导出，且你只需要其中一部分，使用import { namedExport } from 'module'。
   • 如果模块有多个命名导出，且你希望将它们作为命名空间对象来访问（尤其是在需要保持原有Module.method()调用模式时），使用import * as ModuleName from 'module'。

遵循这些原则，将能有效避免和解决JavaScript模块导入相关的错误，提升开发效率和代码质量。

以上就是深入理解ESM：解决JavaScript模块导入“未提供导出”错误的详细内容，更多请关注php中文网其它相关文章！