mirror of
https://github.com/cachix/install-nix-action.git
synced 2024-11-22 08:30:51 +00:00
70 lines
986 B
Markdown
70 lines
986 B
Markdown
# 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.
|
|
|
|
|
|
## 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)
|