node/deps/npm/node_modules/which
npm CLI robot 306de763f2
deps: upgrade npm to 10.0.0
PR-URL: https://github.com/nodejs/node/pull/49423
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Debadree Chatterjee <debadree333@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruy Adorno <ruyadorno@google.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
2023-09-06 19:54:44 +00:00
..
bin deps: upgrade npm to 9.1.3 2022-12-07 03:18:33 +00:00
lib deps: upgrade npm to 10.0.0 2023-09-06 19:54:44 +00:00
node_modules/isexe deps: upgrade npm to 10.0.0 2023-09-06 19:54:44 +00:00
LICENSE
README.md deps: upgrade npm to 9.6.6 2023-05-07 10:37:34 +00:00
package.json deps: upgrade npm to 10.0.0 2023-09-06 19:54:44 +00:00

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 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.