讲师中心 微信公众号
AI工具推荐 视频效率加速

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

大墨吖_8822

大墨吖_8822

发布时间:2026-08-06 20:24:25

|

372人浏览过

|

来源于php中文网

原创

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

本文详解如何正确配置 TypeScript 编译、导出与打包,确保生成的 dist 文件可被 React 等前端项目正常导入使用,避免 undefined 或 is not a function 等运行时错误。

本文详解如何正确配置 typescript 编译、导出与打包,确保生成的 `dist` 文件可被 react 等前端项目正常导入使用,避免 `undefined` 或 `is not a function` 等运行时错误。

在将 TypeScript 代码构建成可供前端直接消费的包时,仅启用 declaration: true 和 noEmit: false 是远远不够的——关键在于输出格式(module format)入口文件声明构建产物完整性。你遇到的 myObject is undefined 和 getKeys is not a function 错误,本质是 Webpack(或 Vite)在解析 import { myObject, getKeys } from "my-package" 时,未能从 dist 中找到有效的 ES 模块导出,通常源于以下核心问题:

✅ 正确的 tsconfig.json 配置(关键项)

{
  "compilerOptions": {
    "target": "ES2018",
    "module": "ESNext",           // 必须设为 ESNext(而非 CommonJS),以生成原生 ES 模块
    "lib": ["ES2018", "DOM"],
    "declaration": true,          // 生成 .d.ts 类型声明文件
    "declarationMap": true,
    "sourceMap": true,
    "outDir": "./dist",
    "rootDir": "./src",
    "moduleResolution": "node",
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "noEmit": false,              // 允许 emit 输出
    "emitDeclarationOnly": false  // 确保同时输出 .js 和 .d.ts
  },
  "include": ["src/**/*"],
  "exclude": ["src/**/*.test.ts"]
}

⚠️ 特别注意:"module": "ESNext" 是前端可导入的前提;若设为 "CommonJS",则 dist/index.js 将使用 module.exports = {},而现代打包器默认按 ESM 解析,导致命名导入失败。

✅ 确保 package.json 显式声明模块入口

{
  "name": "my-package",
  "version": "1.0.0",
  "main": "./dist/index.js",        // CommonJS 入口(兼容旧工具)
  "module": "./dist/index.js",      // ESM 入口(Webpack/Vite 优先读取)
  "types": "./dist/index.d.ts",     // 类型定义入口
  "exports": {
    ".": {
      "import": "./dist/index.js",  // ESM 模块路径(推荐)
      "require": "./dist/index.js"  // CJS 路径(如需 Node.js 支持)
    }
  },
  "files": ["dist"]
}

? exports 字段比 main/module 更精准,能强制现代打包器使用 ESM,避免降级到 CommonJS 导致的导出不匹配。

✅ 构建命令与验证

运行构建:

立即学习前端免费学习笔记(深入)”;

tsc --build
# 或使用 npm script: "build": "tsc --build"

构建后检查 dist/index.js 内容是否为有效 ESM:

前端美化
前端美化

使用此技能可创建独具特色、具备生产级质量的前端界面,设计品质高。当用户要求构建网页组件、页面、产物、海报或应用程序时(例如:网站、落地页、仪表盘、React 组件、HTML/CSS 布局,或对任意 Web UI 进行样式优化与视觉美化),请启用该能力。输出需为富有创意、精雕细琢的代码与 UI 设计,避免千篇一律的 AI 风格。

下载
// ✅ 正确示例(ESM 格式)
export const myObject = { a: 1, b: 2 };
export function getKeys() {
  return Object.keys(myObject);
}
export function getValues() {
  return Object.values(myObject);
}

❌ 若看到 exports.myObject = ... 或 Object.defineProperty(exports, ...),说明 module 配置错误,仍在输出 CommonJS。

✅ 在 React 前端中安全使用

// ✅ 正确导入(基于 ESM)
import { myObject, getKeys, getValues } from "my-package";

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

⚠️ 常见陷阱与修复建议

  • 未指定 rootDir / outDir 导致输出混乱:确保 src/index.ts 是唯一入口,且 outDir 不与 src 重叠。
  • 缺少 types 字段:VS Code 能识别是因为 .d.ts 存在,但运行时无影响;types 字段确保类型检查准确。
  • 未清理旧构建产物:执行 rm -rf dist && tsc --build 避免缓存干扰。
  • React 项目未启用 ESM 解析:Vite 默认支持;Create React App(CRA)v5+ 也支持 ESM,但若用旧版 CRA,请升级或改用 craco 配置。

✅ 进阶推荐:使用 Rollup 或 tsup(更健壮)

对于库开发,纯 tsc 仅做转译,不处理 Tree-shaking 或 polyfill。推荐轻量打包工具:

npm install -D tsup

tsup.config.ts:

export default {
  entry: ["src/index.ts"],
  format: ["esm"], // 强制输出 ES 模块
  dts: true,       // 自动生成类型声明
  outDir: "dist",
};

运行 npx tsup 即可获得开箱即用的 ESM 包。

总结:TypeScript 库要被前端正确消费,核心是 ESM 输出 + 正确 package.json 入口声明 + 清晰的构建产物结构。跳过任一环节都可能导致运行时导出失效。务必验证 dist/index.js 是否为原生 export 语法,并通过 npm link 或本地 file: 依赖在真实 React 项目中测试导入行为。

热门AI工具

更多
火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

相关专题

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

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

2023

2023.08.11

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

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

4323

2023.10.09

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

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

5450

2024.03.19

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

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

4898

2024.03.22

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

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

683

2024.05.22

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

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

4086

2023.06.20

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

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

1049

2023.07.04

js四舍五入
js四舍五入

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

3964

2023.07.04

Vibeknow在线使用入口合集
Vibeknow在线使用入口合集

本专题汇总了Vibeknow在线创作视频的官方入口及网页版使用教程,涵盖PPT、PDF、Word等文档一键转讲解视频的核心操作,并整理了免费版水印规则与手机端浏览器访问指南,助你快速将知识内容视频化。

0

2026.09.21

热门下载

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

精品课程

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

共58课时 | 11.9万人学习

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

共12课时 | 1.4万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn