-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
30 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,34 @@ | ||
The "which" util from npm's guts. | ||
# which | ||
|
||
Like the unix `which` utility. | ||
|
||
Finds the first instance of a specified executable in the PATH | ||
environment variable. Does not cache the results, so `hash -r` is not | ||
needed when the PATH changes. | ||
|
||
## USAGE | ||
|
||
```javascript | ||
var which = require('which') | ||
|
||
// async usage | ||
which('node', function (er, resolvedPath) { | ||
// er is returned if no "node" is found on the PATH | ||
// if it is found, then the absolute path to the exec is returned | ||
}) | ||
|
||
// sync usage | ||
// throws if not found | ||
var resolved = which.sync('node') | ||
|
||
// Pass options to override the PATH and PATHEXT environment vars. | ||
which('node', { path: someOtherPath }, function (er, resolved) { | ||
if (er) | ||
throw er | ||
console.log('found at %j', resolved) | ||
}) | ||
``` | ||
|
||
## OPTIONS | ||
|
||
If you pass in options, then `path` and `pathExt` are relevant. |