1.0.3 • Published 7 years ago

flagr v1.0.3

Weekly downloads
2
License
UNLICENSED
Repository
github
Last release
7 years ago

Get all flags present on argv and his value easily Check if argv has a specific flag

npm version Dependency Status David npm

Install

$ npm install --save flagr

Usage

Check if a given flag exists

$ node foo.js --prod --watch --env="production"
// foo.js
const { exist } = require('flagr');

exist('--prod');
//=> true

exist('prod');
//=> true

exist('--watch');
//=> true

exist('--env');
//=> true

exist('--test');
//=> false

Retrieve flag value

$ node foo.js --prod --watch="true" --env="production"
// foo.js
const { get } = require('flagr');

get('--prod');
//=> ''

get('--watch');
//=> true

get('--env');
//=> production

get('env');
//=> production

API

exist(flag, argv)

Returns a boolean whether the flag exists.

flag

Type: string

CLI flag to look for. The -- prefix is optional.

argv

Type: array Default: process.argv

get(flag, argv)

Returns the value from flag.

flag

Type: string

CLI flag to look for. The -- prefix is optional.

argv

Type: array Default: process.argv