Skip to content

sindresorhus/has-flag

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Jul 19, 2021
0c7d032 · Jul 19, 2021

History

22 Commits
Apr 16, 2021
Jan 2, 2018
Apr 6, 2019
Jan 2, 2018
Jan 2, 2018
Apr 16, 2021
Jul 19, 2021
Apr 16, 2021
Apr 16, 2021
Jul 19, 2021
Apr 16, 2021
Apr 16, 2021

Repository files navigation

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.