node/deps/npm/node_modules/read-cmd-shim
Rebecca Turner 507fc53e37 deps: upgrade npm to 3.3.10
PR-URL: https://github.com/nodejs/node/pull/3599
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2015-11-02 14:25:04 -05:00
..
test deps: upgrade npm to 3.3.6 2015-10-22 13:56:09 -04:00
.npmignore deps: upgrade npm to 3.3.6 2015-10-22 13:56:09 -04:00
index.js deps: upgrade npm to 3.3.6 2015-10-22 13:56:09 -04:00
package.json deps: upgrade npm to 3.3.10 2015-11-02 14:25:04 -05:00
README.md deps: upgrade npm to 3.3.6 2015-10-22 13:56:09 -04:00

read-cmd-shim

Figure out what a cmd-shim is pointing at. This acts as the equivalent of fs.readlink.

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.