path-exists

中文文档
5.0.0发布于 2021/08/12MITES Module零依赖近 30 天下载 9.3亿

Check if a path exists

原始使用文档
文档目录6 节
  1. Install
  2. Usage
  3. API
  4. pathExists(path)
  5. pathExistsSync(path)
  6. Related

path-exists

Check if a path exists

NOTE: fs.existsSync has been un-deprecated in Node.js since 6.8.0. If you only need to check synchronously, this module is not needed.

Never use this before handling a file though:

In particular, checking if a file exists before opening it is an anti-pattern that leaves you vulnerable to race conditions: another process may remove the file between the calls to fs.exists() and fs.open(). Just open the file and handle the error when it's not there.

Install

$ npm install path-exists

Usage

// foo.js
import {pathExists} from 'path-exists';

console.log(await pathExists('foo.js'));
//=> true

API

pathExists(path)

Returns a Promise<boolean> of whether the path exists.

pathExistsSync(path)

Returns a boolean of whether the path exists.

  • path-exists-cli - CLI for this module
  • path-type - Check if a path exists and whether it's a file, directory, or symlink

Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.

版本与发布记录

path-exists 共发布 6 个版本,首次发布于 2015/05/03;过去 12 个月发布了 0 个版本。

版本发布日期距今
5.0.0latest2021/08/125 年前
4.0.02019/04/047 年前
3.0.02016/05/0110 年前
2.1.02015/11/1410 年前
2.0.02015/09/0111 年前
1.0.02015/05/0311 年前

关于 path-exists 的常见问题

path-exists 是什么?

Check if a path exists

如何安装 path-exists?

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

path-exists 支持 TypeScript 吗?

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

path-exists 支持 ESM 还是 CommonJS?

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

path-exists 需要什么版本的 Node.js?

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

path-exists 可以商用吗?

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

path-exists 的下载量有多少?

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

path-exists 还在维护吗?

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