node/deps/npm/node_modules/which
Kat Marchán 9946519fba deps: upgrade npm to 4.0.5
PR-URL: https://github.com/nodejs/node/pull/10330
Reviewed-By: Myles Borins <myles.borins@gmail.com>
2016-12-28 15:30:50 -05:00
..
bin deps: upgrade npm to 3.3.10 2015-11-02 14:25:04 -05:00
node_modules/isexe deps: upgrade npm to 3.9.3 2016-05-28 10:42:48 -04:00
CHANGELOG.md deps: upgrade npm to 4.0.5 2016-12-28 15:30:50 -05:00
LICENSE npm: upgrade to v2.1.18 2015-01-08 23:49:03 +01:00
package.json deps: upgrade npm to 4.0.5 2016-12-28 15:30:50 -05:00
README.md deps: upgrade npm to 3.6.0 2016-02-01 10:43:34 -05:00
which.js deps: upgrade npm to 4.0.5 2016-12-28 15:30:50 -05: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

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)
})

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.