Sha256: 104d57d22d82213c4e38d7947cf861c44af4e5de378686ab2a083dd946d444df
Contents?: true
Size: 1.44 KB
Versions: 7
Compression:
Stored size: 1.44 KB
Contents
# isexe
Minimal module to check if a file is executable.
Uses `fs.access` if available, and tests against the `PATHEXT`
environment variable on Windows.
## USAGE
```javascript
var isexe = require('isexe')
isexe('some-file-name', function (err, isExe) {
if (err) {
console.error('probably file does not exist or something', err)
} else if (isExe) {
console.error('this thing can be run')
} else {
console.error('cannot be run')
}
})
// same thing but synchronous, throws errors
var isExe = isexe.sync('some-file-name')
// treat errors as just "not executable"
isexe('maybe-missing-file', { ignoreErrors: true }, callback)
var isExe = isexe.sync('maybe-missing-file', { ignoreErrors: true })
```
## API
### `isexe(path, [options], [callback])`
Check if the path is executable. If no callback provided, and a
global `Promise` object is available, then a Promise will be returned.
Will raise whatever errors may be raised by `fs.access` or `fs.stat`,
unless `options.ignoreErrors` is set to true.
### `isexe.sync(path, [options])`
Same as `isexe` but returns the value and throws any errors raised.
### Options
* `ignoreErrors` Treat all errors as "no, this is not executable", but
don't raise them.
* `uid` Number to use as the user id when using the `mode` approach.
* `gid` Number to use as the group id when using the `mode` approach.
* `pathExt` List of path extensions to use instead of `PATHEXT`
environment variable on Windows.
Version data entries
7 entries across 6 versions & 3 rubygems