# locate-path 中文文档

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

版本：8\.0\.0
npm 元数据更新时间：2025-09-15T23:17:38.996Z
中文译文更新时间：2026-11-04T11:28:40.333Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：7.2 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：1 个
- 首次发布：2016-11-20T10:27:29.562Z
- 最新版本发布：2025-09-15T23:17:38.813Z
- 近 30 天下载量：1269641618（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 0 个）

## 中文简介

获取多个路径中磁盘上存在的第一个路径

## 安装

```sh
npm install locate-path
```

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

## README

# locate-path

> 获取多个路径中磁盘上存在的第一个路径

## 安装

```sh
npm install locate-path
```

## 用法

在这里，我们按照数组顺序找到磁盘上存在的第一个文件。

```js
import {locatePath} from 'locate-path';

const files = [
    'unicorn.png',
    'rainbow.png', // Only this one actually exists on disk
    'pony.png'
];

console.log(await locatePath(files));
//=> 'rainbow.png'
```

## API

### locatePath(路径,选择?)

返回一个 `Promise<string>` 对于存在的第一个路径或 `undefined` 如果不存在。

#### 路径

类型: `Iterable<string>`

检查路径。

#### 选项

类型: `object`

##### 并发性

类型: `number`  
默认值: `Infinity`  
最低: `1`

并发等待的承诺的数量。

##### preserveOrder

类型: `boolean`  
默认值: `true`

保存 `paths` 搜索时要有次序。

如果您不关心顺序，请禁用此选项以提高性能。

##### 慢性消耗病

类型: `URL | string`  
默认值: `process.cwd()`

当前工作目录。

##### 类型

类型: `string`  
默认值: `'file'`  
价值观: `'file' | 'directory' | 'both'`

要匹配的路径类型。

-   `'file'` -只匹配文件
-   `'directory'` -只匹配目录
-   `'both'` —匹配文件和目录

##### allowSymlinks

类型: `boolean`  
默认值: `true`

如果符号链接指向所选的路径类型，则允许它们匹配。

### locatePathSync(路径,选择?)

返回存在的第一个路径 `undefined` 如果不存在。

#### 路径

类型: `Iterable<string>`

检查路径。

#### 选项

类型: `object`

##### 慢性消耗病

同上。

##### 类型

同上。

##### allowSymlinks

同上。

## 相关

-   [路径](https://github.com/sindresorhus/path-exists) —检查是否存在路径

## 常见问题

### locate-path 是什么？

获取多个路径中磁盘上存在的第一个路径

### 如何安装 locate-path？

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

### locate-path 支持 TypeScript 吗？

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

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

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

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

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

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

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

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

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

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

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