Have ideas to improve npm?Join in the discussion! »

    has-flag
    TypeScript icon, indicating that this package has built-in type declarations

    5.0.0 • Public • Published

    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.

    Install

    npm i has-flag

    DownloadsWeekly Downloads

    63,700,432

    Version

    5.0.0

    License

    MIT

    Unpacked Size

    4.21 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar