# path-key 中文文档

规范地址：https://npmcn.com/package/path-key/

版本：4\.0\.0
npm 元数据更新时间：2023-06-17T00:09:27.470Z
中文译文更新时间：2026-11-04T11:31:33.140Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：4.1 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=12
- 运行依赖：0 个
- 首次发布：2015-12-28T18:36:51.108Z
- 最新版本发布：2021-04-09T12:04:51.822Z
- 近 30 天下载量：1245925417（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 0 个）

## 中文简介

获取跨平台的PATH环境变量密钥

## 安装

```sh
npm install path-key
```

也可以使用：`pnpm add path-key`、`yarn add path-key`、`bun add path-key`

## README

# path-key

> 得到了 [路径](https://en.wikipedia.org/wiki/PATH_\(variable\)) 环境变量键跨平台

这通常是 `PATH` 但在Windows上，它可以是任何外壳，比如 `Path`…

## 安装

```
$ npm install path-key
```

## 用法

```js
import pathKey from 'path-key';

const key = pathKey();
//=> 'PATH'

const PATH = process.env[key];
//=> '/usr/local/bin:/usr/bin:/bin'
```

## API

### pathKey(选项?)

#### 选项

类型: `object`

##### env

类型: `object`  
默认值: [`process.env`](https://nodejs.org/api/process.html#process_process_env)

使用自定义环境变量对象。

#### 平台

类型: `string`  
默认值: [`process.platform`](https://nodejs.org/api/process.html#process_process_platform)

获取特定平台的PATH键。

* * *

**[通过订阅Tidelift获得此软件包的专业支持](https://tidelift.com/subscription/pkg/npm-path-key?utm_source=npm-path-key&utm_medium=referral&utm_campaign=readme)**  
Tidelift帮助维护人员使开源可持续，同时给公司  
关于其依赖项的安全性、维护和许可的保证。

## 常见问题

### path-key 是什么？

获取跨平台的PATH环境变量密钥

### 如何安装 path-key？

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

### path-key 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/path-key 是否存在。

### path-key 支持 ESM 还是 CommonJS？

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

### path-key 需要什么版本的 Node\.js？

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

### path-key 可以商用吗？

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

### path-key 的下载量有多少？

根据 npm 官方下载统计，path-key 在 2026/10/05 – 2026/11/03 这 30 天内被下载 1,245,925,417 次，日均约 41,530,847 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### path-key 还在维护吗？

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