https://github.com/simonepri/bin-manager

🌀 Binaries available as local nodeJS dependencies
https://github.com/simonepri/bin-manager

bin-dep bin-dependency bin-packing bin-wrapper binary-manager binary-wrapper node node-binary

Last synced: 3 months ago
JSON representation

🌀 Binaries available as local nodeJS dependencies

• Host: GitHub
• URL: https://github.com/simonepri/bin-manager
• Owner: simonepri
• License: mit
• Created: 2017-07-09T16:20:55.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-01-08T13:29:25.000Z (almost 7 years ago)
• Last Synced: 2024-10-15T07:32:10.620Z (3 months ago)
• Topics: bin-dep, bin-dependency, bin-packing, bin-wrapper, binary-manager, binary-wrapper, node, node-binary
• Language: JavaScript
• Homepage:
• Size: 490 KB
• Stars: 8
• Watchers: 6
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# NodeJS Binary Manager [![Travis CI](https://travis-ci.org/simonepri/bin-manager.svg?branch=master)](https://travis-ci.org/simonepri/bin-manager) [![Codecov](https://img.shields.io/codecov/c/github/simonepri/bin-manager/master.svg)](https://codecov.io/gh/simonepri/bin-manager) [![npm](https://img.shields.io/npm/dm/bin-manager.svg)](https://www.npmjs.com/package/bin-manager) [![npm version](https://img.shields.io/npm/v/bin-manager.svg)](https://www.npmjs.com/package/bin-manager)

> 🌀 Binaries available as local nodeJS dependencies

## Install

```

$ npm install --save bin-manager

```

## Usage

```js

const bmanager = require('bin-manager');

const base = 'https://github.com/imagemin/gifsicle-bin/raw/master/vendor';

const bin = bmanager('bin', 'gifsicle')

  .src(base + '/macos/gifsicle', 'darwin')

  .src(base + '/linux/x64/gifsicle', 'linux', 'x64')

  .src(base + '/win/x64/gifsicle.exe', 'win32', 'x64')

  .use(process.platform === 'win32' ? 'gifsicle.exe' : 'gifsicle');

bin.run(['--version'], (err, out) => {

  if (err) {

    console.log(error);

    return;

  }

  console.log(out.stdout);

});

```

## API

### bmanager(dist, slug)

Creates a new `bmanager` instance.

##### dist

Type: `string`


Default: `''`

Accepts a path where the binaries will be stored to.

##### slug

Type: `string`


Default: `''`

Accepts an unique slug for the binary.


The binary will be downloaded inside the path: `dist/slug`

### .src([url], [os], [arch])

Adds a source to download.

If 0 arguments are passed, the array of current setted sources is returned.

#### url

Type: `string`

Accepts a URL pointing to a file to download.

#### os

Type: `string`

Tie the source to a specific OS.

#### arch

Type: `string`

Tie the source to a specific arch.

### .dest(destination)

Adds a destination folder.

#### destination

Type: `string`

The path which the files will be downloaded to.

### .use([binary])

Get or set the binary path of the extracted file.

#### binary

Type: `string`

Define which file to use as executable.

If undefined the current setted value is returned.

### .path()

Returns the full path where the binary will downloaded to.

### .bin()

Returns the full path to your binary.

### .remote()

Returns the URLs that will be used/was used to download the binaries for your platform.

### .load([options], callback)

Runs the search for the binary. If no binary is found it will download it

using the URL provided in `.src()`.


It usese [download](https://github.com/kevva/download) under the hood.


See [here](https://github.com/kevva/download#options) all available options.

#### options

Type: `Object`


Default: `{extract: true}`

#### callback(err)

Type: `Function`

### .unload([options], callback)

Removes downloaded binaries, if presents.


It usese [del](https://github.com/sindresorhus/del) under the hood.


See [here](https://github.com/sindresorhus/del#options) all available options.

#### options

Type: `Object`


Default: `{}`

#### callback(err)

Type: `Function`

### .run([arguments], [options], callback)

Runs the binary. If the binary is not loaded it will also load it.


It usese [execa](https://github.com/sindresorhus/execa) under the hood.


See [here](https://github.com/sindresorhus/execa#options) all available options.

#### arguments

Type: `Array`


Default: `[]`

#### options

Type: `Object`


Default: `{}`

#### callback(err, out)

Type: `Function`

Returns a possible error and the output object.

## Authors

* **Simone Primarosa** - [simonepri](https://github.com/simonepri)

See also the list of [contributors](https://github.com/simonepri/bin-manager/contributors) who participated in this project.

Heavily inspired from [bin-wrapper](https://github.com/kevva/bin-wrapper)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.