Security News
JSR Working Group Kicks Off with Ambitious Roadmap and Plans for Open Governance
At its inaugural meeting, the JSR Working Group outlined plans for an open governance model and a roadmap to enhance JavaScript package management.
base-option
Advanced tools
Adds a few options methods to base, like `option`, `enable` and `disable`. See the readme for the full API.
Adds a few options methods to base, like
option
,enable
anddisable
. See the readme for the full API.
Install with npm:
$ npm install base-option --save
Use as a plugin with with your base
application:
var Base = require('base-methods');
var options = require('base-option');
var base = new Base();
base.use(options()); // plugin
// set an option
app.option('a', 'b');
// set a nested property
app.option('x.y', 'z');
// get an option
console.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 a value
when only key
is defined.Example
app.option('a', true);
app.option('a');
//=> true
Return true if options.hasOwnProperty(key)
Params
prop
{String}returns
{Boolean}: True if prop
exists.Example
app.hasOption('a');
//=> false
app.option('a', 'b');
app.hasOption('a');
//=> true
Enable key
.
Params
key
{String}returns
{Object} Options
: to enable chainingExample
app.enable('a');
Disable key
.
Params
key
{String}: The option to disable.returns
{Object} Options
: to enable chainingExample
app.disable('a');
Check if prop
is enabled (truthy).
Params
prop
{String}returns
{Boolean}Example
app.enabled('a');
//=> false
app.enable('a');
app.enabled('a');
//=> true
Check if prop
is disabled (falsey).
Params
prop
{String}returns
{Boolean}: Returns true if prop
is disabled.Example
app.disabled('a');
//=> true
app.enable('a');
app.disabled('a');
//=> false
Returns true if the value of prop
is strictly true
.
Params
prop
{String}returns
{Boolean}: Uses strict equality for comparison.Example
app.option('a', 'b');
app.isTrue('a');
//=> false
app.option('c', true);
app.isTrue('c');
//=> true
app.option({a: {b: {c: true}}});
app.isTrue('a.b.c');
//=> true
Returns true if the value of key
is strictly false
.
Params
prop
{String}returns
{Boolean}: Uses strict equality for comparison.Example
app.option('a', null);
app.isFalse('a');
//=> false
app.option('c', false);
app.isFalse('c');
//=> true
app.option({a: {b: {c: false}}});
app.isFalse('a.b.c');
//=> true
Return true if the value of key is either true
or false
.
Params
key
{String}returns
{Boolean}: True if true
or false
.Example
app.option('a', 'b');
app.isBoolean('a');
//=> false
app.option('c', true);
app.isBoolean('c');
//=> true
Set option key
on app.options
with the given value
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 option key
from app.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 of app.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
var opts = app.option.create();
opts.merge({foo: 'bar'});
data
method to base-methods. | homepagePull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Generate readme and API documentation with verb:
$ npm install verb && npm run docs
Or, if verb is installed globally:
$ verb
Install dev dependencies:
$ npm install -d && npm test
Jon Schlinkert
Copyright © 2016 Jon Schlinkert Released under the MIT license.
This file was generated by verb, v0.9.0, on March 09, 2016.
FAQs
Adds a few options methods to base, like `option`, `enable` and `disable`. See the readme for the full API.
We found that base-option demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At its inaugural meeting, the JSR Working Group outlined plans for an open governance model and a roadmap to enhance JavaScript package management.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.