# parent-module 中文文档

规范地址：https://npmcn.com/package/parent-module/

版本：3\.2\.0
npm 元数据更新时间：2025-09-15T07:20:45.510Z
中文译文更新时间：2026-11-05T01:38:43.188Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/parent-module
原文对照：https://npmcn.com/package/parent-module/?lang=original
项目主页：https://github.com/sindresorhus/parent-module#readme
源码仓库：https://github.com/sindresorhus/parent-module

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：5 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：^12\.20\.0 \|\| ^14\.13\.1 \|\| \>=16\.0\.0
- 运行依赖：1 个
- 首次发布：2016-01-22T15:05:41.453Z
- 最新版本发布：2025-09-15T07:20:45.338Z
- 近 30 天下载量：535055549（2026-10-04 至 2026-11-02，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 0 个）

## 中文简介

获取父模块的路径

## 安装

```sh
npm install parent-module
```

也可以使用：`pnpm add parent-module`、`yarn add parent-module`、`bun add parent-module`

## README

# parent-module

> 获取父模块的路径

该模块提供了一种可靠的方式来获取调用代码的模块的文件路径，可以正确地与CommonJS和ESM模块一起工作。

## 安装

```sh
npm install parent-module
```

## 用法

```js
// bar.js
import parentModule from 'parent-module';

export default function bar() {
    console.log(parentModule());
    //=> '/Users/sindresorhus/dev/unicorn/foo.js'
}
```

```js
// foo.js
import bar from './bar.js';

bar();
```

## API

### parentModule (filePath ?)

返回: `string | undefined`

返回直接父模块的文件路径，或 `undefined` 如果没有父模块（例如，从入口模块的顶层调用时）。

#### filePath

类型: `string`  
默认值: `import.meta.filename`

要获取父路径的模块的文件路径。

用于在遍历调用时获取特定模块的父模块 [多个模块级别](https://npmcn.com/package/parent-module/fixtures/filepath)。

## 提示

将它与 [`read-package-up`](https://github.com/sindresorhus/read-package-up) 阅读包装。父模块的Json。

```js
import path from 'node:path';
import {readPackageUpSync} from 'read-package-up';
import parentModule from 'parent-module';

const parent = parentModule();
if (parent) {
    console.log(readPackageUpSync({cwd: path.dirname(parent)}).pkg);
    //=> {name: 'chalk', version: '1.0.0', …}
}
```

## 常见问题

### parent-module 是什么？

获取父模块的路径

### 如何安装 parent-module？

在项目目录运行 npm install parent-module，或使用 pnpm add / yarn add / bun add。

### parent-module 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### parent-module 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### parent-module 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js ^12\.20\.0 \|\| ^14\.13\.1 \|\| \>=16\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### parent-module 可以商用吗？

parent-module 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### parent-module 的下载量有多少？

根据 npm 官方下载统计，parent-module 在 2026/10/04 – 2026/11/02 这 30 天内被下载 535,055,549 次，日均约 17,835,185 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### parent-module 还在维护吗？

最新版本 3\.2\.0 发布于 2025/09/15（1\.1 年前）；至今共发布 7 个版本，其中过去 12 个月发布了 0 个；首次发布于 2016/01/22。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。