Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

resolve-bin

thlorenz177.4kMIT1.0.1TypeScript support: definitely-typed

Resolves the full path to the bin file of a given package by inspecting the "bin" field in its package.json.

resolve, bin, module

readme

resolve-bin Tests

Resolves the full path to the bin file of a given package by inspecting the "bin" field in its package.json.

var resolveBin = require('resolve-bin');

// package.json: "bin": "bin/tap.js"
resolveBin('tap', function (err, bin) {
  if (err) return console.error(err);
  console.log(bin);  
});

// => [..]/resolve-bin/node_modules/tap/bin/tap.js

Installation

npm install resolve-bin

API

resolveBin(name, opts, cb)

Resolves the full path to the bin file of a given package by inspecting the "bin" field in its package.json.

Parameters:
Name Type Argument Description
name string

module name, i.e. 'tap'
opts Object <optional>

options

Properties
Name Type Description
executable string

(default: @name) executable name (e.g. 'buster-test')
cb function

called back with the full path to the bin file of the module or an error if it couldn't be resolved
Source:

resolveBin::sync(name, opts) → {string}

Synchronous version of resolveBin

Parameters:
Name Type Argument Description
name string

module name, i.e. 'tap'
opts Object <optional>

options

Properties
Name Type Description
executable string

(default: @name) executable name (e.g. 'buster-test')
Source:

generated with docme

License

MIT