History

Nat 96939b7aee Clean up repo and update deps		2024-03-10 11:52:04 -07:00
..
index.d.ts	Clean up repo and update deps	2024-03-10 11:52:04 -07:00
index.js	Clean up repo and update deps	2024-03-10 11:52:04 -07:00
license	Clean up repo and update deps	2024-03-10 11:52:04 -07:00
package.json	Clean up repo and update deps	2024-03-10 11:52:04 -07:00
readme.md	Clean up repo and update deps	2024-03-10 11:52:04 -07:00

readme.md

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.

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.

path-exists-cli - CLI for this module