ubdate
This commit is contained in:
51
node_modules/bin-check/readme.md
generated
vendored
Normal file
51
node_modules/bin-check/readme.md
generated
vendored
Normal file
@@ -0,0 +1,51 @@
|
||||
# bin-check [](https://travis-ci.org/kevva/bin-check)
|
||||
|
||||
> Check if a binary is working by checking its exit code
|
||||
|
||||
|
||||
## Install
|
||||
|
||||
```
|
||||
$ npm install bin-check
|
||||
```
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
const binCheck = require('bin-check');
|
||||
|
||||
binCheck('/bin/sh', ['--version']).then(works => {
|
||||
console.log(works);
|
||||
//=> true
|
||||
});
|
||||
```
|
||||
|
||||
|
||||
## API
|
||||
|
||||
### binCheck(binary, [arguments])
|
||||
|
||||
Returns a `Promise` for a `boolean`.
|
||||
|
||||
### binCheck.sync(binary, [arguments])
|
||||
|
||||
Returns a `boolean`.
|
||||
|
||||
#### binary
|
||||
|
||||
Type: `string`
|
||||
|
||||
Path to the binary.
|
||||
|
||||
#### arguments
|
||||
|
||||
Type: `Array`<br>
|
||||
Default: `['--help']`
|
||||
|
||||
Arguments to run the binary with.
|
||||
|
||||
|
||||
## License
|
||||
|
||||
MIT © [Kevin Mårtensson](https://github.com/kevva)
|
||||
Reference in New Issue
Block a user