blob: 457e36e35fca55bbde7e60cfdd3eb8ee890dc178 (
plain)
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
|
# 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
```
const readCmdShim = require('read-cmd-shim')
readCmdShim('/path/to/shim.cmd').then(destination => {
…
})
const destination = readCmdShim.sync('/path/to/shim.cmd')
```
### readCmdShim(path) -> Promise
Reads the `cmd-shim` located at `path` and resolves 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.
|
