aboutsummaryrefslogtreecommitdiff
path: root/node_modules/fs-extra/docs/pathExists.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/fs-extra/docs/pathExists.md')
-rw-r--r--node_modules/fs-extra/docs/pathExists.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/node_modules/fs-extra/docs/pathExists.md b/node_modules/fs-extra/docs/pathExists.md
new file mode 100644
index 0000000..0302b09
--- /dev/null
+++ b/node_modules/fs-extra/docs/pathExists.md
@@ -0,0 +1,22 @@
+# pathExists(file[, callback])
+
+Test whether or not the given path exists by checking with the file system. Like [`fs.exists`](https://nodejs.org/api/fs.html#fs_fs_exists_path_callback), but with a normal callback signature (err, exists). Uses `fs.access` under the hood.
+
+- `file` `<String>`
+- `callback` `<Function>`
+
+## Example:
+
+```js
+const fs = require('fs-extra')
+
+const file = '/tmp/this/path/does/not/exist/file.txt'
+// Promise usage:
+fs.pathExists(file)
+ .then(exists => console.log(exists)) // => false
+// Callback usage:
+fs.pathExists(file, (err, exists) => {
+ console.log(err) // => null
+ console.log(exists) // => false
+})
+```