Blame view

node_modules/has-flag/readme.md 986 Bytes
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
  # has-flag [![Build Status](https://travis-ci.org/sindresorhus/has-flag.svg?branch=master)](https://travis-ci.org/sindresorhus/has-flag)
  
  > Check if [`argv`](https://nodejs.org/docs/latest/api/process.html#process_process_argv) has a specific flag
  
  Correctly stops looking after an `--` argument terminator.
  
  
  ## Install
  
  ```
  $ npm install has-flag
  ```
  
  
  ## Usage
  
  ```js
  // foo.js
  const hasFlag = require('has-flag');
  
  hasFlag('unicorn');
  //=> true
  
  hasFlag('--unicorn');
  //=> true
  
  hasFlag('f');
  //=> true
  
  hasFlag('-f');
  //=> true
  
  hasFlag('foo=bar');
  //=> true
  
  hasFlag('foo');
  //=> false
  
  hasFlag('rainbow');
  //=> false
  ```
  
  ```
  $ node foo.js -f --unicorn --foo=bar -- --rainbow
  ```
  
  
  ## API
  
  ### hasFlag(flag, [argv])
  
  Returns a boolean for whether the flag exists.
  
  #### flag
  
  Type: `string`
  
  CLI flag to look for. The `--` prefix is optional.
  
  #### argv
  
  Type: `string[]`<br>
  Default: `process.argv`
  
  CLI arguments.
  
  
  ## License
  
  MIT © [Sindre Sorhus](https://sindresorhus.com)