Last change
on this file since 571e0df was 6a3a178, checked in by Ema <ema_spirova@…>, 3 years ago |
initial commit
|
-
Property mode
set to
100644
|
File size:
1.4 KB
|
Line | |
---|
1 | # path-exists [![Build Status](https://travis-ci.org/sindresorhus/path-exists.svg?branch=master)](https://travis-ci.org/sindresorhus/path-exists)
|
---|
2 |
|
---|
3 | > Check if a path exists
|
---|
4 |
|
---|
5 | 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.
|
---|
6 |
|
---|
7 | While [`fs.exists()`](https://nodejs.org/api/fs.html#fs_fs_exists_path_callback) is being [deprecated](https://github.com/iojs/io.js/issues/103), there's still a genuine use-case of being able to check if a path exists for other purposes than doing IO with it.
|
---|
8 |
|
---|
9 | Never use this before handling a file though:
|
---|
10 |
|
---|
11 | > 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.
|
---|
12 |
|
---|
13 |
|
---|
14 | ## Install
|
---|
15 |
|
---|
16 | ```
|
---|
17 | $ npm install path-exists
|
---|
18 | ```
|
---|
19 |
|
---|
20 |
|
---|
21 | ## Usage
|
---|
22 |
|
---|
23 | ```js
|
---|
24 | // foo.js
|
---|
25 | const pathExists = require('path-exists');
|
---|
26 |
|
---|
27 | (async () => {
|
---|
28 | console.log(await pathExists('foo.js'));
|
---|
29 | //=> true
|
---|
30 | })();
|
---|
31 | ```
|
---|
32 |
|
---|
33 |
|
---|
34 | ## API
|
---|
35 |
|
---|
36 | ### pathExists(path)
|
---|
37 |
|
---|
38 | Returns a `Promise<boolean>` of whether the path exists.
|
---|
39 |
|
---|
40 | ### pathExists.sync(path)
|
---|
41 |
|
---|
42 | Returns a `boolean` of whether the path exists.
|
---|
43 |
|
---|
44 |
|
---|
45 | ## Related
|
---|
46 |
|
---|
47 | - [path-exists-cli](https://github.com/sindresorhus/path-exists-cli) - CLI for this module
|
---|
48 |
|
---|
49 |
|
---|
50 | ## License
|
---|
51 |
|
---|
52 | MIT © [Sindre Sorhus](https://sindresorhus.com)
|
---|
Note:
See
TracBrowser
for help on using the repository browser.