deployphp/node_modules/which/README.md

49 lines
1.2 KiB
Markdown
Raw Normal View History

2020-11-10 22:12:02 +00:00
# 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
2023-03-28 15:15:22 +00:00
const which = require('which')
2020-11-10 22:12:02 +00:00
// async usage
2023-03-28 15:15:22 +00:00
// rejects if not found
const resolved = await which('node')
2020-11-10 22:12:02 +00:00
2023-03-28 15:15:22 +00:00
// if nothrow option is used, returns null if not found
const resolvedOrNull = await which('node', { nothrow: true })
2020-11-10 22:12:02 +00:00
// sync usage
// throws if not found
2023-03-28 15:15:22 +00:00
const resolved = which.sync('node')
2020-11-10 22:12:02 +00:00
// if nothrow option is used, returns null if not found
2023-03-28 15:15:22 +00:00
const resolvedOrNull = which.sync('node', { nothrow: true })
2020-11-10 22:12:02 +00:00
// Pass options to override the PATH and PATHEXT environment vars.
2023-03-28 15:15:22 +00:00
await which('node', { path: someOtherPath, pathExt: somePathExt })
2020-11-10 22:12:02 +00:00
```
## CLI USAGE
Same as the BSD `which(1)` binary.
```
usage: which [-as] program ...
```
## OPTIONS
You may pass an options object as the second argument.
- `path`: Use instead of the `PATH` environment variable.
- `pathExt`: Use instead of the `PATHEXT` environment variable.
- `all`: Return all matches, instead of just the first one. Note that
this means the function returns an array of strings instead of a
single string.