History

Theunis J. Botha 5f5bbac56e initial comit		2020-02-27 15:24:35 +01:00
..
index.js	initial comit	2020-02-27 15:24:35 +01:00
license	initial comit	2020-02-27 15:24:35 +01:00
package.json	initial comit	2020-02-27 15:24:35 +01:00
readme.md	initial comit	2020-02-27 15:24:35 +01:00

readme.md

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.