has-flag

Check if argv has a specific flag

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
has-flag
8805.0.13 years ago9 years agoMinified + gzip package size for has-flag in KB

Readme

has-flag
Check if argv has a specific flag

Install

$ npm install has-flag

Usage

// foo.js
import hasFlag from '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.
It correctly stops looking after an -- argument terminator.

flag

Type: string
CLI flag to look for. The -- prefix is optional.

argv

Type: string[]\ Default: process.argv
CLI arguments.
<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>