Blame view

node_modules/path-exists/readme.md 1.27 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
  # path-exists [![Build Status](https://travis-ci.org/sindresorhus/path-exists.svg?branch=master)](https://travis-ci.org/sindresorhus/path-exists)
  
  > Check if a path exists
  
  Because [`fs.exists()`](https://nodejs.org/api/fs.html#fs_fs_exists_path_callback) is being [deprecated](https://github.com/iojs/io.js/issues/103), 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
  
  ```js
  // 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.
  
  
  ## Related
  
  - [path-exists-cli](https://github.com/sindresorhus/path-exists-cli) - CLI for this module
  
  
  ## License
  
  MIT © [Sindre Sorhus](https://sindresorhus.com)