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

JS 中怎么在 package.json 中使用 exports 字段限制子路径导出

轻强姑娘_3167

轻强姑娘_3167

发布时间:2026-10-30 13:41:26

|

390人浏览过

|

来源于php中文网

原创

package.json 的 "exports" 字段显式声明公共入口和子路径导出规则,取代 main/module/types 等字段,默认屏蔽未声明子路径;支持 ESM/CommonJS/类型声明、条件导出及通配符(需谨慎使用)。

js 中怎么在 package.json 中使用 exports 字段限制子路径导出

在 Node.js 中,package.json 的 "exports" 字段用于**显式声明包的公共入口和子路径导出规则**,它会完全取代传统的 main、module、types 等字段(除非在 exports 中显式代理),并**默认屏蔽所有未声明的子路径访问**(比如 require('pkg/internal/utils') 会报错)。这是实现“封装性”和“意图明确导出”的关键机制。

基础写法:定义默认入口和命名子路径

以下是一个典型配置,支持 ESM 和 CommonJS,并导出多个子路径:

{
  "name": "my-lib",
  "type": "module",
  "exports": {
    ".": {
      "import": "./dist/index.mjs",
      "require": "./dist/index.cjs"
    },
    "./utils": {
      "import": "./dist/utils.mjs",
      "require": "./dist/utils.cjs"
    },
    "./constants": "./dist/constants.js",
    "./package.json": "./package.json"
  }
}

说明:

  • "." 是默认入口,对应 import 'my-lib' 或 require('my-lib');
  • "./utils" 是一个显式允许的子路径,对应 import 'my-lib/utils';
  • "./package.json" 是常见需求——允许消费者读取自身 package.json(如获取 version);
  • 未列出的路径(如 ./src/xxx、./lib/internal)全部被禁止,Node.js 会抛出 ERR_PACKAGE_PATH_NOT_EXPORTED 错误。

支持类型声明(TypeScript)

若提供 TypeScript 类型,需在对应子路径中同时声明 types(或 types 字段):

arcgis-js
arcgis-js

提供 ArcGIS Maps SDK for JavaScript 开发辅助,涵盖 2D/3D 地图视图、图层管理、数据可视化、空间分析等功能模块的参考和示例指导。

下载
"./utils": {
  "import": "./dist/utils.mjs",
  "require": "./dist/utils.cjs",
  "types": "./dist/types/utils.d.ts"
}

注意:types 不是标准字段,但 TypeScript 和主流工具(如 VS Code、tsc)识别它。也可用条件导出统一处理:

"./utils": {
  "types": "./dist/types/utils.d.ts",
  "import": "./dist/utils.mjs",
  "require": "./dist/utils.cjs"
}

禁止所有子路径(仅保留主入口)

如果只想暴露根入口,**不声明任何 ./xxx 条目即可**。但要注意:即使没写 "./package.json",也建议显式添加,否则 import pkg from 'my-lib/package.json' 也会失败:

"exports": {
  ".": {
    "import": "./dist/index.mjs",
    "require": "./dist/index.cjs"
  },
  "./package.json": "./package.json"
}

高级:条件导出 + 模式匹配(Node.js ≥ 18.12)

可使用 "*" 通配符(需配合 "default" 回退)实现灵活子路径,但要谨慎——它会放宽封装性:

"exports": {
  ".": "./dist/index.js",
  "./features/*": "./dist/features/*.js",
  "./": "./dist/" // ❌ 危险!等价于开放全部子路径
}

更安全的写法是只对明确模式放行:

  • "./features/*" 允许 import 'pkg/features/a' → 解析为 dist/features/a.js;
  • 避免裸 "./" 或 "*",否则破坏封装意图;
  • 通配路径仍受文件存在性检查,不存在的 features/xxx 仍会报错。

热门AI工具

更多
讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

WorkBuddy

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

豆包大模型

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

切问学术

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

DeepSeek

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

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

相关专题

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

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

5366

2023.06.20

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

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

1309

2023.07.04

js四舍五入
js四舍五入

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

5304

2023.07.04

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

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

1000

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

1956

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

3725

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

4893

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

3200

2023.09.20

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

60

2026.10.28

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.4万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.7万人学习

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

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