summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/fs.realpath/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/node_modules/fs.realpath/README.md')
-rw-r--r--deps/npm/node_modules/fs.realpath/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/deps/npm/node_modules/fs.realpath/README.md b/deps/npm/node_modules/fs.realpath/README.md
new file mode 100644
index 0000000000..a42ceac626
--- /dev/null
+++ b/deps/npm/node_modules/fs.realpath/README.md
@@ -0,0 +1,33 @@
+# fs.realpath
+
+A backwards-compatible fs.realpath for Node v6 and above
+
+In Node v6, the JavaScript implementation of fs.realpath was replaced
+with a faster (but less resilient) native implementation. That raises
+new and platform-specific errors and cannot handle long or excessively
+symlink-looping paths.
+
+This module handles those cases by detecting the new errors and
+falling back to the JavaScript implementation. On versions of Node
+prior to v6, it has no effect.
+
+## USAGE
+
+```js
+var rp = require('fs.realpath')
+
+// async version
+rp.realpath(someLongAndLoopingPath, function (er, real) {
+ // the ELOOP was handled, but it was a bit slower
+})
+
+// sync version
+var real = rp.realpathSync(someLongAndLoopingPath)
+
+// monkeypatch at your own risk!
+// This replaces the fs.realpath/fs.realpathSync builtins
+rp.monkeypatch()
+
+// un-do the monkeypatching
+rp.unmonkeypatch()
+```