hf

has-flag

Check if argv has a specific flag

Showing:

Popularity

Downloads/wk

79.8M

GitHub Stars

76

Maintenance

Last Commit

3mos ago

Contributors

6

Package

Dependencies

0

Size (min+gzip)

0.3KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

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.


Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial