wallet-core/node_modules/has-flag/readme.md

68 lines
961 B
Markdown
Raw Normal View History

2017-05-03 15:35:00 +02:00
# 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 --save has-flag
```
## Usage
```js
// foo.js
2017-08-14 05:01:11 +02:00
const hasFlag = require('has-flag');
2017-05-03 15:35:00 +02:00
hasFlag('unicorn');
//=> true
hasFlag('--unicorn');
//=> true
2017-08-14 05:01:11 +02:00
hasFlag('-f');
//=> true
2017-05-03 15:35:00 +02:00
hasFlag('foo=bar');
//=> true
hasFlag('foo');
//=> false
hasFlag('rainbow');
//=> false
```
```
2017-08-14 05:01:11 +02:00
$ node foo.js -f --unicorn --foo=bar -- --rainbow
2017-05-03 15:35:00 +02:00
```
## API
### hasFlag(flag, [argv])
Returns a boolean whether the flag exists.
#### flag
Type: `string`
CLI flag to look for. The `--` prefix is optional.
#### argv
2017-08-14 05:01:11 +02:00
Type: `array`<br>
2017-05-03 15:35:00 +02:00
Default: `process.argv`
CLI arguments.
## License
2017-08-14 05:01:11 +02:00
MIT © [Sindre Sorhus](https://sindresorhus.com)