A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://www.npmjs.com/package/base-option below:

base-option - npm

base-option

Adds a few options methods to base, like option, enable and disable. See the readme for the full API.

Install

Install with npm:

$ npm install --save base-option

Usage

Use as a plugin with with your base application:

var Base = require('base');

var options = require('base-option');

 

var base = new Base();

base.use(options()); 

 

app.option('a', 'b');

 

app.option('x.y', 'z');

 

console.log(app.option('x'));

API .option

Set or get an option.

Params

Example

app.option('a', true);

app.option('a');

.hasOption

Return true if options.hasOwnProperty(key)

Params

Example

app.hasOption('a');

app.option('a', 'b');

app.hasOption('a');

.enable

Enable key.

Params

Example

.disable

Disable key.

Params

Example

.enabled

Check if prop is enabled (truthy).

Params

Example

app.enabled('a');

 

app.enable('a');

app.enabled('a');

.disabled

Check if prop is disabled (falsey).

Params

Example

app.disabled('a');

 

app.enable('a');

app.disabled('a');

.isTrue

Returns true if the value of prop is strictly true.

Params

Example

app.option('a', 'b');

app.isTrue('a');

 

app.option('c', true);

app.isTrue('c');

 

app.option({a: {b: {c: true}}});

app.isTrue('a.b.c');

.isFalse

Returns true if the value of key is strictly false.

Params

Example

app.option('a', null);

app.isFalse('a');

 

app.option('c', false);

app.isFalse('c');

 

app.option({a: {b: {c: false}}});

app.isFalse('a.b.c');

.isBoolean

Return true if the value of key is either true or false.

Params

Example

app.option('a', 'b');

app.isBoolean('a');

 

app.option('c', true);

app.isBoolean('c');

.option.set

Set option key on app.options with the given value

Params

Example

app.option.set('a', 'b');

console.log(app.option.get('a'));

.option.get

Get option key from app.options

Params

Example

app.option({a: 'b'});

console.log(app.option.get('a'));

.option.create

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

Params

Example

var opts = app.option.create();

opts.merge({foo: 'bar'});

About Related projects Contributing

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

Contributors Building docs

(This project's readme.md is generated by verb, 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 tests

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 && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

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


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4