File size: 1,156 Bytes
bc20498 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 |
# executable [](https://travis-ci.org/kevva/executable)
> Check if a file is executable
## Install
```
$ npm install --save executable
```
## Usage
```js
const executable = require('executable');
executable('bash').then(exec => {
console.log(exec);
//=> true
});
```
## API
### executable(file)
Returns a Promise for a boolean.
### executable.sync(file)
Returns a boolean of whether the file is executable.
#### file
Type: `string`
Path of the file.
### executable.checkMode(mode, [gid], [uid])
Returns a boolean of whether the mode passed as first argument means that the file is executable.
#### mode
Type: `number`
Property `mode` of `fs.Stats` instance returned by `fs.stat()` (or `fs.statSync()`) function.
#### gid, uid
Type: `number`
Respectively the group identity and user identity of the file. If not set, permissions will be evaluated without considering owner or group of the file.
## Related
* [executable-cli](https://github.com/kevva/executable-cli) - CLI for this module
## License
MIT © [Kevin Mårtensson](https://github.com/kevva)
|