aboutsummaryrefslogtreecommitdiff
path: root/deps/node/deps/npm/node_modules/read-cmd-shim/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/node/deps/npm/node_modules/read-cmd-shim/README.md')
-rw-r--r--deps/node/deps/npm/node_modules/read-cmd-shim/README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/deps/node/deps/npm/node_modules/read-cmd-shim/README.md b/deps/node/deps/npm/node_modules/read-cmd-shim/README.md
new file mode 100644
index 00000000..2f0b5f6c
--- /dev/null
+++ b/deps/node/deps/npm/node_modules/read-cmd-shim/README.md
@@ -0,0 +1,36 @@
+# read-cmd-shim
+
+Figure out what a [`cmd-shim`](https://github.com/ForbesLindesay/cmd-shim)
+is pointing at. This acts as the equivalent of
+[`fs.readlink`](https://nodejs.org/api/fs.html#fs_fs_readlink_path_callback).
+
+### Usage
+
+```
+var readCmdShim = require('read-cmd-shim')
+
+readCmdShim('/path/to/shim.cmd', function (er, destination) {
+ …
+})
+
+var destination = readCmdShim.sync('/path/to/shim.cmd')
+
+### readCmdShim(path, callback)
+
+Reads the `cmd-shim` located at `path` and calls back with the _relative_
+path that the shim points at. Consider this as roughly the equivalent of
+`fs.readlink`.
+
+This can read both `.cmd` style that are run by the Windows Command Prompt
+and Powershell, and the kind without any extension that are used by Cygwin.
+
+This can return errors that `fs.readFile` returns, except that they'll
+include a stack trace from where `readCmdShim` was called. Plus it can
+return a special `ENOTASHIM` exception, when it can't find a cmd-shim in the
+file referenced by `path`. This should only happen if you pass in a
+non-command shim.
+
+
+### readCmdShim.sync(path)
+
+Same as above but synchronous. Errors are thrown.