Repository files navigation

Adds a few options methods to base, likeoption,enable anddisable. See the readme for the full API.

Install withnpm:

$ npm install --save base-option

Use as a plugin with with yourbase application:

varBase=require('base');varoptions=require('base-option');varbase=newBase();base.use(options());// plugin// set an optionapp.option('a','b');// set a nested propertyapp.option('x.y','z');// get an optionconsole.log(app.option('x'));//=> {y: 'z'}

Set or get an option.

Params

• key{String}: The option name.
• value{any}: The value to set.
• returns{any}: Returns avalue when onlykey is defined.

Example

app.option('a',true);app.option('a');//=> true

Return true ifoptions.hasOwnProperty(key)

Params

• prop{String}
• returns{Boolean}: True ifprop exists.

Example

app.hasOption('a');//=> falseapp.option('a','b');app.hasOption('a');//=> true

Enablekey.

Params

• key{String}
• returns{Object}Options: to enable chaining

Example

app.enable('a');

Disablekey.

Params

• key{String}: The option to disable.
• returns{Object}Options: to enable chaining

Example

app.disable('a');

Check ifprop is enabled (truthy).

Params

• prop{String}
• returns{Boolean}

Example

app.enabled('a');//=> falseapp.enable('a');app.enabled('a');//=> true

Check ifprop is disabled (falsey).

Params

• prop{String}
• returns{Boolean}: Returns true ifprop is disabled.

Example

app.disabled('a');//=> trueapp.enable('a');app.disabled('a');//=> false

Returns true if the value ofprop is strictlytrue.

Params

• prop{String}
• returns{Boolean}: Uses strict equality for comparison.

Example

app.option('a','b');app.isTrue('a');//=> falseapp.option('c',true);app.isTrue('c');//=> trueapp.option({a:{b:{c:true}}});app.isTrue('a.b.c');//=> true

Returns true if the value ofkey is strictlyfalse.

Params

• prop{String}
• returns{Boolean}: Uses strict equality for comparison.

Example

app.option('a',null);app.isFalse('a');//=> falseapp.option('c',false);app.isFalse('c');//=> trueapp.option({a:{b:{c:false}}});app.isFalse('a.b.c');//=> true

Return true if the value of key is eithertrue orfalse.

Params

• key{String}
• returns{Boolean}: True iftrue orfalse.

Example

app.option('a','b');app.isBoolean('a');//=> falseapp.option('c',true);app.isBoolean('c');//=> true

Set optionkey onapp.options with the givenvalue

Params

• key{String}: Option key, dot-notation may be used.
• value{any}

Example

app.option.set('a','b');console.log(app.option.get('a'));//=> 'b'

Get optionkey fromapp.options

Params

• key{String}: Option key, dot-notation may be used.
• returns{any}

Example

app.option({a:'b'});console.log(app.option.get('a'));//=> 'b'

Returns a shallow clone ofapp.options with all of the options methods, as well as a.merge method for merging options onto the cloned object.

Params

• options{Options}: Object to merge onto the returned options object.
• returns{Object}

Example

varopts=app.option.create();opts.merge({foo:'bar'});

• base-data: adds adata method to base-methods. |homepage
• base-task: base plugin that provides a very thin wrapper aroundhttps://github.com/doowb/composer for adding task methods to…more |homepage
• base: Framework for rapidly creating high quality node.js applications, using plugins like building blocks |homepage

Pull requests and stars are always welcome. For bugs and feature requests,please create an issue.

(This project's readme.md is generated byverb, please don't edit the readme directly. Any changes to the readme must be made in the.verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme&& verb

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install&& npmtest

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

Copyright © 2017,Jon Schlinkert.Released under theMIT License.

This file was generated byverb-generate-readme, v0.6.0, on May 30, 2017.