parent-module

中文文档
3.2.0发布于 2025/09/15MITTypeScriptES Module近 30 天下载 5.4亿

Get the path of the parent module

原始使用文档
文档目录5 节
  1. Install
  2. Usage
  3. API
  4. parentModule(filePath?)
  5. Tip

parent-module

Get the path of the parent module

This module provides a reliable way to get the file path of the module that called your code, working correctly with both CommonJS and ESM modules.

Install

npm install parent-module

Usage

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

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

bar();

API

parentModule(filePath?)

Returns: string | undefined

Returns the file path of the immediate parent module, or undefined if there is no parent module (for example, when called from the top-level of an entry module).

filePath

Type: string
Default: import.meta.filename

The file path of the module for which to get the parent path.

Useful for getting the parent of a specific module when the call traverses multiple module levels.

Tip

Combine it with read-package-up to read the package.json of the parent module.

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 共发布 7 个版本,首次发布于 2016/01/22;过去 12 个月发布了 0 个版本。

版本发布日期距今
3.2.0latest2025/09/151.1 年前
3.1.02023/09/143 年前
3.0.02021/10/045 年前
2.0.02019/04/307 年前
1.0.12019/03/287 年前
1.0.02018/12/257 年前

关于 parent-module 的常见问题

parent-module 是什么?

Get the path of the 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 和提交记录判断。