如何正确构建并发布 TypeScript 库供前端(如 React)直接使用

雨丽大大_3075

雨丽大大_3075

2026-08-06

646人浏览

原创

如何正确构建并发布 TypeScript 库供前端(如 React)直接使用

本文详解如何正确配置 typescript 项目以生成可被 webpack/react 直接导入的 es 模块,解决 undefined 导出和 is not a function 等运行时错误。关键在于输出格式、模块解析与入口文件配置。

本文详解如何正确配置 typescript 项目以生成可被 webpack/react 直接导入的 es 模块,解决 undefined 导出和 is not a function 等运行时错误。关键在于输出格式、模块解析与入口文件配置。

要让 TypeScript 编写的库(如 my-package)在 React 前端中正常工作,仅启用 declaration: true 和 noEmit: false 是远远不够的。你遇到的 myObject is undefined 和 WEBPACK_IMPORTED_MODULE_1.getKeys is not a function 错误,根本原因在于:TypeScript 编译器默认生成 CommonJS(CJS)模块代码,而现代前端构建工具(如 Webpack/Vite)期望的是 ESM(ECMAScript Module)格式,并依赖正确的 package.json 入口字段进行模块解析。

✅ 正确构建步骤

1. 配置 tsconfig.json 输出为 ESM

确保编译目标为现代 JavaScript,并显式指定模块系统:

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "ESNext",        // ← 关键:生成 ES 模块语法(import/export)
    "lib": ["ES2020", "DOM"],
    "declaration": true,
    "declarationMap": true,
    "sourceMap": true,
    "outDir": "./dist",
    "rootDir": "./src",
    "strict": true,
    "esModuleInterop": true,   // 兼容 CJS 依赖(推荐保留)
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "moduleResolution": "NodeNext" // ← 关键:启用 Node.js 的 ESM 解析规则
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "dist", "**/*.test.ts"]
}

⚠️ 注意:"module": "ESNext" + "moduleResolution": "NodeNext" 是 ESM 支持的前提;"target": "ES2020" 确保语法兼容主流浏览器。

2. 设置 package.json 的模块入口

在 my-package/package.json 中明确声明 ESM 入口,让打包工具优先加载 .mjs 或 exports 字段:

{
  "name": "my-package",
  "version": "1.0.0",
  "types": "./dist/index.d.ts",
  "main": "./dist/index.js",           // CommonJS 入口(兼容旧环境)
  "module": "./dist/index.js",         // ← ESM 入口(Webpack 传统用法)
  "exports": {
    ".": {
      "import": "./dist/index.mjs",    // ← 推荐:显式 .mjs 入口(Vite/Webpack 5+ 优先)
      "require": "./dist/index.js"
    }
  },
  "typesVersions": {
    "*": {
      "dist/*": ["dist/*"]
    }
  }
}

✅ 构建后,确保 dist/ 下存在:

react-pro
react-pro

你是一位 React 专家,擅长高级 Hook、性能优化、状态管理和现代 React 模式。适用场景:高级 Hook 模式...

下载
  • index.js(ESM 格式,含 export const myObject = ...)
  • index.mjs(可选,但更明确;可通过 tsc + cp 或 rollup 生成)
  • index.d.ts(类型定义)

3. 构建命令建议

使用 tsc 直接构建(无需额外打包工具):

# 清理并构建
npx tsc --build --clean && npx tsc

# 或添加 script 到 package.json
"scripts": {
  "build": "tsc --build"
}

构建完成后,验证 dist/index.js 内容是否为标准 ESM:

// dist/index.js(应为如下格式,非 require/module.exports)
export const myObject = { a: 1, b: 2 };
export function getKeys() {
  return Object.keys(myObject);
}
export function getValues() {
  return Object.values(myObject);
}

4. 在 React 中安全导入

确保 React 项目已启用 ESM 支持(Create React App ≥ 5.0 / Vite / Webpack 5+ 默认支持):

// ✅ 正确导入(自动解析 exports.import)
import { myObject, getKeys } from 'my-package';

console.log(myObject); // {a: 1, b: 2}
console.log(getKeys()); // ['a', 'b']

? 如果使用较老的 CRA(

? 常见陷阱排查

  • ❌ module: "CommonJS" → 生成 module.exports,前端无法解构导入;
  • ❌ 缺少 "type": "module" 或 exports 字段 → 工具回退到 CJS 解析;
  • ❌ outDir 与 rootDir 路径错误 → 导致 dist 为空或未生成 .d.ts;
  • ❌ tsconfig.json 被 extends 覆盖 → 检查继承链中 module 是否被重写。

✅ 总结

TypeScript 库要在前端可靠运行,核心是 “输出 ESM + 正确声明入口 + 类型对齐”。不要依赖 IDE 的类型提示(它只读 .d.ts),而要验证最终 dist/ 中的 JS 文件是否真正包含 export 语句。构建后建议手动检查 dist/index.js 内容,并在 React 项目中 console.log 验证导出值——这是最直接有效的验证方式。

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

react 前端 typescript

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2483

5

前端如何实现即时通讯
前端如何实现即时通讯

实现即时通讯的方法有WebSocket、Long Polling、Server-Sent Events、WebRTC等等。详细介绍:1、WebSocket,它可以在客户端和服务器之间建立持久连接,实现实时的双向通信,前端可以使用 WebSocket API来创建WebSocket连接,并通过发送和接收消息来实现即时通讯;2、Long Polling,是一种模拟实时通信的技术等等。

2023.10.09

5363

6

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

6390

13

php和前端的关联介绍
php和前端的关联介绍

php既可以作为前端语言,也可以作为后端语言。想了解更多php和前端的相关内容,可以阅读本专题下面的文章。

2024.03.22

5998

10

前端外包工作内容有哪些
前端外包工作内容有哪些

前端外包工作内容包括:1. 网站和应用程序开发;2. 用户界面和交互设计;3. 用户体验优化;4. 设计和视觉开发;5. 跨浏览器兼容性;6. 性能优化;7. 维护和更新;8. 项目管理和沟通。想了解更多前端的相关内容,可以阅读本专题下面的文章。

2024.05.22

863

5

js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4886

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1209

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4824

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

960

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
React 教程
React 教程

共58课时 | 12.2万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1.4万人学习