| 1 | # which
|
| 2 |
|
| 3 | Like the unix `which` utility.
|
| 4 |
|
| 5 | Finds the first instance of a specified executable in the PATH
|
| 6 | environment variable. Does not cache the results, so `hash -r` is not
|
| 7 | needed when the PATH changes.
|
| 8 |
|
| 9 | ## USAGE
|
| 10 |
|
| 11 | ```javascript
|
| 12 | var which = require('which')
|
| 13 |
|
| 14 | // async usage
|
| 15 | which('node', function (er, resolvedPath) {
|
| 16 | // er is returned if no "node" is found on the PATH
|
| 17 | // if it is found, then the absolute path to the exec is returned
|
| 18 | })
|
| 19 |
|
| 20 | // sync usage
|
| 21 | // throws if not found
|
| 22 | var resolved = which.sync('node')
|
| 23 |
|
| 24 | // Pass options to override the PATH and PATHEXT environment vars.
|
| 25 | which('node', { path: someOtherPath }, function (er, resolved) {
|
| 26 | if (er)
|
| 27 | throw er
|
| 28 | console.log('found at %j', resolved)
|
| 29 | })
|
| 30 | ```
|
| 31 |
|
| 32 | ## CLI USAGE
|
| 33 |
|
| 34 | Same as the BSD `which(1)` binary.
|
| 35 |
|
| 36 | ```
|
| 37 | usage: which [-as] program ...
|
| 38 | ```
|
| 39 |
|
| 40 | ## OPTIONS
|
| 41 |
|
| 42 | You may pass an options object as the second argument.
|
| 43 |
|
| 44 | - `path`: Use instead of the `PATH` environment variable.
|
| 45 | - `pathExt`: Use instead of the `PATHEXT` environment variable.
|
| 46 | - `all`: Return all matches, instead of just the first one. Note that
|
| 47 | this means the function returns an array of strings instead of a
|
| 48 | single string.
|