| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889 |
- # has-flag [](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.
- ---
- <div align="center">
- <b>
- <a href="https://tidelift.com/subscription/pkg/npm-has-flag?utm_source=npm-has-flag&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
- </b>
- <br>
- <sub>
- Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
- </sub>
- </div>
- ---
- ## 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.
- ## Security
- To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.
- ## License
- MIT © [Sindre Sorhus](https://sindresorhus.com)
|
