website/node_modules/bin-version-check/readme.md

In JohnCoene/chirp: 'Twitter' Networks Analyser

bin-version-check

Check whether a binary version satisfies a semver range

Useful when you have a thing that only works with specific versions of a binary.

Install

$ npm install bin-version-check

Usage

$ curl --version
curl 7.30.0 (x86_64-apple-darwin13.0)

const binVersionCheck = require('bin-version-check');

(async () => {
    try {
        await binVersionCheck('curl', '>=8');
    } catch (error) {
        console.log(error);
        //=> 'InvalidBinVersion: curl 7.30.0 doesn't satisfy the version requirement of >=8'
    }
})();

API

binVersionCheck(binary, semverRange, [options])

binary

Type: string

Name or path of the binary to check.

semverRange

Type: string

Semver range to check against.

options

Type: Object

args

Type: string[] Default: ['--version']

CLI arguments used to get the binary version.

Related

• bin-version-check-cli - CLI for this module

License

MIT © Sindre Sorhus

JohnCoene/chirp documentation built on May 25, 2021, 6:33 p.m.