d5ed384a2fPR-URL: https://github.com/nodejs/node/pull/62215 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jordan Harband <ljharb@gmail.com> |
||
|---|---|---|
| .. | ||
| bin | ||
| lib | ||
| node_modules/isexe | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
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
const which = require('which')
// async usage
// rejects if not found
const resolved = await which('node')
// if nothrow option is used, returns null if not found
const resolvedOrNull = await which('node', { nothrow: true })
// sync usage
// throws if not found
const resolved = which.sync('node')
// if nothrow option is used, returns null if not found
const resolvedOrNull = which.sync('node', { nothrow: true })
// Pass options to override the PATH and PATHEXT environment vars.
await which('node', { path: someOtherPath, pathExt: somePathExt })
CLI USAGE
Just like the BSD which(1) binary but using node-which.
usage: node-which [-as] program ...
You can learn more about why the binary is node-which and not which
here
OPTIONS
You may pass an options object as the second argument.
path: Use instead of thePATHenvironment variable.pathExt: Use instead of thePATHEXTenvironment 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.