mirror of
https://github.com/nodejs/node.git
synced 2025-05-20 17:41:40 +00:00
2e54524955
PR-URL: https://github.com/nodejs/node/pull/35474 Reviewed-By: Ruy Adorno <ruyadorno@github.com> Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org> Reviewed-By: Ben Coe <bencoe@gmail.com> Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com> Reviewed-By: Guy Bedford <guybedford@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
37 lines
1.1 KiB
Markdown
37 lines
1.1 KiB
Markdown
# 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.
|