Skip to content
Check if a path exists
JavaScript TypeScript
Branch: master
Clone or download
Latest commit 0ed4a86 May 31, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Tidelift tasks May 31, 2019
.editorconfig
.gitattributes Require Node.js 8, add TypeScript definition (#10) Apr 4, 2019
.gitignore Require Node.js 8, add TypeScript definition (#10) Apr 4, 2019
.npmrc Require Node.js 8, add TypeScript definition (#10) Apr 4, 2019
.travis.yml Add Node.js 12 to testing (#11) Apr 27, 2019
index.d.ts Require Node.js 8, add TypeScript definition (#10) Apr 4, 2019
index.js Meta tweaks Apr 4, 2019
index.test-d.ts Require Node.js 8, add TypeScript definition (#10) Apr 4, 2019
license Require Node.js 8, add TypeScript definition (#10) Apr 4, 2019
package.json 4.0.0 Apr 4, 2019
readme.md Tidelift tasks May 31, 2019
test.js Require Node.js 8, add TypeScript definition (#10) Apr 4, 2019

readme.md

path-exists Build Status

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.

While fs.exists() is being deprecated, there's still a genuine use-case of being able to check if a path exists for other purposes than doing IO with it.

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
const pathExists = require('path-exists');

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

API

pathExists(path)

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

pathExists.sync(path)

Returns a boolean of whether the path exists.

Related


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.
You can’t perform that action at this time.