BlueGit

blue-star danique-bot

Files

danique-bot / node_modules / isexe / README.md

README.md

Import template
timfa Tim · pushed by timfa · 4 years ago
c788ad20 History
README.md 1.4 KiB Download Raw

isexe

Minimal module to check if a file is executable, and a normal file.

Uses fs.stat and tests against the PATHEXT environment variable on Windows.

USAGE

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.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
  • gid Number to use as the group id
  • pathExt List of path extensions to use instead of PATHEXT

environment variable on Windows.

Source
1# isexe
2
3Minimal module to check if a file is executable, and a normal file.
4
5Uses `fs.stat` and tests against the `PATHEXT` environment variable on
6Windows.
7
8## USAGE
9
10```javascript
11var isexe = require('isexe')
12isexe('some-file-name', function (err, isExe) {
13 if (err) {
14 console.error('probably file does not exist or something', err)
15 } else if (isExe) {
16 console.error('this thing can be run')
17 } else {
18 console.error('cannot be run')
19 }
20})
21
22// same thing but synchronous, throws errors
23var isExe = isexe.sync('some-file-name')
24
25// treat errors as just "not executable"
26isexe('maybe-missing-file', { ignoreErrors: true }, callback)
27var isExe = isexe.sync('maybe-missing-file', { ignoreErrors: true })
28```
29
30## API
31
32### `isexe(path, [options], [callback])`
33
34Check if the path is executable. If no callback provided, and a
35global `Promise` object is available, then a Promise will be returned.
36
37Will raise whatever errors may be raised by `fs.stat`, unless
38`options.ignoreErrors` is set to true.
39
40### `isexe.sync(path, [options])`
41
42Same as `isexe` but returns the value and throws any errors raised.
43
44### Options
45
46* `ignoreErrors` Treat all errors as "no, this is not executable", but
47 don't raise them.
48* `uid` Number to use as the user id
49* `gid` Number to use as the group id
50* `pathExt` List of path extensions to use instead of `PATHEXT`
51 environment variable on Windows.