has-flag

Check if argv has a specific flag

Correctly stops looking after an -- argument terminator.

Install

$ npm install has-flag 

Usage

// 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[]
Default: process.argv

CLI arguments.

License

MIT © Sindre Sorhus