0.3.1 • Published 10 years ago
options-cache v0.3.1
options-cache
Simple API for managing options in JavaScript applications.
Install
Install with npm
npm i options-cache --save
API
Options
Create a new instance of Options
.
options
{Object}: Initialize with default options.
Example:
var util = require('util');
var Options = require('options-cache');
function App(options) {
Options.call(this, options);
}
util.inherits(App, Options);
App.prototype.a = function(value) {
this.enable(value);
};
App.prototype.b = function(value) {
if (this.enabled(value)) {
// do something
}
};
.option
Set or get an option.
key
{String}: The option name.value
{*}: The value to set.returns
{*}: Returns avalue
when onlykey
is defined.
app.option('a', true);
app.option('a');
//=> true
.enabled
Check if key
is enabled (truthy).
key
{String}returns
: {Boolean}
app.enabled('a');
//=> false
app.enable('a');
app.enabled('a');
//=> true
.disabled
Check if key
is disabled (falsey).
key
{String}returns
{Boolean}: Returns true ifkey
is disabled.
app.disabled('a');
//=> true
app.enable('a');
app.disabled('a');
//=> false
.enable
Enable key
.
key
{String}returns
{Object}Options
: to enable chaining
Example
app.enable('a');
.disable
Disable key
.
key
{String}: The option to disable.returns
{Object}Options
: to enable chaining
Example
app.disable('a');
Author
Jon Schlinkert
License
Copyright (c) 2014 Jon Schlinkert, contributors.
Released under the MIT license
This file was generated by verb-cli on October 11, 2014.