mirror of https://github.com/nodejs/node.git synced 2024-12-01 16:10:02 +01:00

History

Rebecca Turner 468ab4519e deps: upgrade npm to 6.1.0 PR-URL: https://github.com/nodejs/node/pull/20190 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>		2018-05-24 23:24:45 -07:00
..
index.js
license
package.json
readme.md

readme.md

path-exists

Check if a path exists

Because fs.exists() is being deprecated, but 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 --save path-exists

Usage

// foo.js
const pathExists = require('path-exists');

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

API

pathExists(path)

Returns a promise for a boolean of whether the path exists.

pathExists.sync(path)

Returns a boolean of whether the path exists.

path-exists-cli - CLI for this module