nopt-defaults

Default options for nopt

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
nopt-defaults
0.0.110 years ago10 years agoMinified + gzip package size for nopt-defaults in KB

Readme

nopt-defaults
Default options for nopt

Usage

npm install nopt nopt-defaults

// my-program.js
var nopt = require('nopt');
var noptDefaults = require('nopt-defaults');

var knownOpts = {
    foo: String,
    bloo: ['big', 'medium', 'small'],
    flag: Boolean
};

var defaults = {
    bloo: 'medium',
    flag: true
};

var parsed = noptDefaults(nopt(knownOpts), defaults);
console.log(parsed);

Examples:
$ node my-program.js
{ "bloo": "medium", "flag": true }

$ node my-program.js --bloo big
{ "bloo": "big", "flag": true }

$ node my-program.js --no-flag
{ "bloo": "medium", "flag": false }

$ node my-program.js --flag false
{ "bloo": "medium", "flag": false }

$ node my-program.js --foo Hi
{ "foo": "Hi", "bloo": "medium", "flag": false }

License

Licensed under the BSD 3-Clause License
, the full text of which can be read in LICENSE.