hasbin

What is hasbin?

The hasbin npm package is used to check if a specific binary is available in the system's PATH. This can be useful for ensuring that required dependencies are installed before running a script or application.

What are hasbin's main functionalities?

Check if a binary exists

This feature allows you to check if a specific binary, such as 'node', exists in the system's PATH. The callback function receives a boolean indicating the presence of the binary.

const hasbin = require('hasbin');

hasbin('node', function(result) {
  if (result) {
    console.log('Node.js is installed');
  } else {
    console.log('Node.js is not installed');
  }
});

Check multiple binaries

This feature allows you to check the existence of multiple binaries in the system's PATH. It iterates over an array of binary names and checks each one, logging the result.

const hasbin = require('hasbin');

const binaries = ['node', 'npm', 'git'];
binaries.forEach(bin => {
  hasbin(bin, function(result) {
    console.log(`${bin} is ${result ? '' : 'not '}installed`);
  });
});

Other packages similar to hasbin

which

The 'which' package is used to locate a command in the system's PATH. It is similar to hasbin but provides more detailed information about the location of the binary. It can be used to find the full path of a binary, whereas hasbin only checks for its existence.

command-exists

The 'command-exists' package checks if a command-line command exists. It is similar to hasbin in that it checks for the presence of a binary, but it also provides a promise-based API in addition to the callback-based API.

execa

The 'execa' package is used for executing shell commands in Node.js. While its primary purpose is not to check for the existence of binaries, it can be used to run commands and check their output, thus indirectly verifying the presence of a binary. It offers more advanced features for command execution compared to hasbin.

README

HasBin

Check whether a binary exists in the PATH environment variable.

var hasbin = require('hasbin');

// Check if a binary exists
hasbin('node', function (result) {
    // result === true
});
hasbin('wtf', function (result) {
    // result === false
});

// Check if all binaries exist
hasbin.all(['node', 'npm'], function (result) {
    // result === true
});

// Check if at least one binary exists
hasbin.some(['node', 'wtf'], function (result) {
    // result === true
});

// Find the first available binary
hasbin.first(['node', 'npm'], function (result) {
    // result === 'node'
});

Table Of Contents

• Install
• Usage
• Contributing
• License

Install

Install HasBin with npm:

npm install hasbin

Usage

hasbin(binaryName, callback)

Check whether a binary exists on one of the paths in process.env.PATH. Calls back with true if it does.

// Arguments
binaryName = String
callback = Function(Boolean)

// Example
hasbin('node', function (result) {
    // result === true
});

hasbin.sync(binaryName)

Synchronous hasbin.

// Arguments
binaryName = String
return Boolean

// Example
result = hasbin.sync('node');

hasbin.all(binaryNames, callback)

Check whether all of a set of binaries exist on one of the paths in process.env.PATH. Calls back with true if all of the binaries do. Aliased as hasbin.every.

// Arguments
binaryNames = Array(String)
callback = Function(Boolean)

// Example
hasbin.all(['node', 'npm'], function (result) {
    // result === true
});

hasbin.all.sync(binaryNames)

Synchronous hasbin.all. Aliased as hasbin.every.sync.

// Arguments
binaryNames = Array(String)
return Boolean

// Example
result = hasbin.all.sync(['node', 'npm']);

hasbin.some(binaryNames, callback)

Check whether at least one of a set of binaries exists on one of the paths in process.env.PATH. Calls back with true if at least one of the binaries does. Aliased as hasbin.any.

// Arguments
binaryNames = Array(String)
callback = Function(Boolean)

// Example
hasbin.some(['node', 'npm'], function (result) {
    // result === true
});

hasbin.some.sync(binaryNames)

Synchronous hasbin.some. Aliased as hasbin.any.sync.

// Arguments
binaryNames = Array(String)
return Boolean

// Example
result = hasbin.some.sync(['node', 'npm']);

hasbin.first(binaryNames, callback)

Checks the list of binaryNames to find the first binary that exists on one of the paths in process.env.PATH. Calls back with the name of the first matched binary if one exists and false otherwise.

// Arguments
binaryNames = Array(String)
callback = Function(String|false)

// Example
hasbin.first(['node', 'npm'], function (result) {
    // result === 'node'
});

hasbin.first.sync(binaryNames)

Synchronous hasbin.first.

// Arguments
binaryNames = Array(String)
return String|false

// Example
result = hasbin.first.sync(['node', 'npm']);

Contributing

To contribute to HasBin, clone this repo locally and commit your code on a separate branch.

Please write unit tests for your code, and check that everything works by running the following before opening a pull-request:

make ci

License

HasBin is licensed under the MIT license.
Copyright © 2015, Springer Nature