locate-path

中文文档
8.0.0发布于 2025/09/16MITTypeScriptES Module近 30 天下载 12.3亿

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

中文使用文档
文档目录6 节
  1. 安装
  2. 用法
  3. API
  4. locatePath(路径,选择?)
  5. locatePathSync(路径,选择?)
  6. 相关

locate-path

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

安装

npm install locate-path

用法

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

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' —匹配文件和目录

类型: boolean
默认值: true

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

locatePathSync(路径,选择?)

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

路径

类型: Iterable<string>

检查路径。

选项

类型: object

慢性消耗病

同上。

类型

同上。

同上。

  • 路径 —检查是否存在路径

版本与发布记录

locate-path 共发布 12 个版本,首次发布于 2016/11/20;过去 12 个月发布了 0 个版本。

版本发布日期距今
8.0.0latest2025/09/161.1 年前
7.2.02023/02/093 年前
7.1.12022/06/064 年前
7.1.02022/02/084 年前
7.0.02021/08/255 年前
6.0.02020/08/116 年前

关于 locate-path 的常见问题

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/04 – 2026/11/02 这 30 天内被下载 1,230,420,508 次,日均约 41,014,017 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

locate-path 还在维护吗?

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