Blame view

node_modules/isexe/README.md 1.36 KB
aaac7fed   liuqimichale   add
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
  # 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
  
  ```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.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.