Package Exports

option-cache

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (option-cache) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

option-cache

Simple API for managing options in JavaScript applications.

Install

Install with npm

npm i option-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 a value when only key 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 if key 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');

.isReversed

Return true if key is prefixed with no.

key {String}
returns {Boolean}: True if key is reversed.

app.isReversed('a');
//=> false

app.isReversed('no_a');
//=> true

.reverse

Reverse the value of key.

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

Example

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

app.reverse('a');
app.option('a');
//=> false

Author

Jon Schlinkert

License

This file was generated by verb on February 12, 2015.