https://github.com/jonschlinkert/option-cache
Get and set options easily, for node.js projects.
https://github.com/jonschlinkert/option-cache
cache config configuration defaults get option options set settings
Last synced: 5 months ago
JSON representation
Get and set options easily, for node.js projects.
- Host: GitHub
- URL: https://github.com/jonschlinkert/option-cache
- Owner: jonschlinkert
- License: mit
- Created: 2014-08-09T11:41:45.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2020-04-01T00:06:21.000Z (over 5 years ago)
- Last Synced: 2024-10-29T11:12:30.195Z (11 months ago)
- Topics: cache, config, configuration, defaults, get, option, options, set, settings
- Language: JavaScript
- Homepage: https://github.com/jonschlinkert
- Size: 103 KB
- Stars: 12
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# option-cache [](https://www.npmjs.com/package/option-cache) [](https://npmjs.org/package/option-cache) [](https://npmjs.org/package/option-cache) [](https://travis-ci.org/jonschlinkert/option-cache)
> Simple API for managing options in JavaScript applications.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save option-cache
```
## Example app
Use options-cache in your javascript application:
```js
var util = require('util');
var Options = require('options-cache');
function App(options) {
Options.call(this, options);
this.init();
}
util.inherits(App, Options);
App.prototype.init = function() {
this.option('cwd', process.cwd());
this.option('foo', 'bar');
};
App.prototype.a = function(value) {
this.enable(value);
};
App.prototype.b = function(value) {
if (this.enabled(value)) {
// do something
} else {
// do something else
}
};
```
## API
### [Options](index.js#L24)
Create a new instance of `Options`.
**Params**
* `options` **{Object}**: Initialize with default options.
**Example**
```js
var app = new Options();
```
### [.option](index.js#L65)
Set or get a default value. Defaults are cached on the `.defaults` object.
**Params**
* `key` **{String}**: The option name.
* `value` **{any}**: The value to set.
* `returns` **{any}**: Returns a `value` when only `key` is defined.
**Example**
```js
app.default('admin', false);
app.default('admin');
//=> false
app.option('admin');
//=> false
app.option('admin', true);
app.option('admin');
//=> true
```
### [.option](index.js#L98)
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**
```js
app.option('a', true);
app.option('a');
//=> true
```
**Params**
* `key` **{String}**
* `value` **{any}**
* `type` **{String}**: Javascript native type (optional)
* `returns` **{Object}**
**Example**
```js
app.option('admin', true);
console.log(app.either('admin', false));
//=> true
console.log(app.either('collaborator', false));
//=> false
```
**Params**
* `key` **{String}**
* `value` **{any}**
* `type` **{String}**: Javascript native type (optional)
* `returns` **{Object}**
**Example**
```js
app.option('a', 'b');
app.fillin('a', 'z');
app.fillin('x', 'y');
app.option('a');
//=> 'b'
app.option('x');
//=> 'y'
```
### [.hasOption](index.js#L204)
Return true if `options.hasOwnProperty(key)`
**Params**
* `prop` **{String}**
* `returns` **{Boolean}**: True if `prop` exists.
**Example**
```js
app.hasOption('a');
//=> false
app.option('a', 'b');
app.hasOption('a');
//=> true
```
### [.enable](index.js#L220)
Enable `key`.
**Params**
* `key` **{String}**
* `returns` **{Object}** `Options`: to enable chaining
**Example**
```js
app.enable('a');
```
### [.disable](index.js#L237)
Disable `key`.
**Params**
* `key` **{String}**: The option to disable.
* `returns` **{Object}** `Options`: to enable chaining
**Example**
```js
app.disable('a');
```
### [.enabled](index.js#L259)
Check if `prop` is enabled (truthy).
**Params**
* `prop` **{String}**
* `returns` **{Boolean}**
**Example**
```js
app.enabled('a');
//=> false
app.enable('a');
app.enabled('a');
//=> true
```
### [.disabled](index.js#L281)
Check if `prop` is disabled (falsey).
**Params**
* `prop` **{String}**
* `returns` **{Boolean}**: Returns true if `prop` is disabled.
**Example**
```js
app.disabled('a');
//=> true
app.enable('a');
app.disabled('a');
//=> false
```
### [.isTrue](index.js#L308)
Returns true if the value of `prop` is strictly `true`.
**Params**
* `prop` **{String}**
* `returns` **{Boolean}**: Uses strict equality for comparison.
**Example**
```js
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
```
### [.isFalse](index.js#L335)
Returns true if the value of `key` is strictly `false`.
**Params**
* `prop` **{String}**
* `returns` **{Boolean}**: Uses strict equality for comparison.
**Example**
```js
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
```
### [.isBoolean](index.js#L359)
Return true if the value of key is either `true` or `false`.
**Params**
* `key` **{String}**
* `returns` **{Boolean}**: True if `true` or `false`.
**Example**
```js
app.option('a', 'b');
app.isBoolean('a');
//=> false
app.option('c', true);
app.isBoolean('c');
//=> true
```
## Release history
### v4.0.0
**Breaking changes**
* `.option` method no longer takes a list or array of objects
* `.mergeOptions` was removed
## About
### Related projects
* [base](https://www.npmjs.com/package/base): Framework for rapidly creating high quality node.js applications, using plugins like building blocks | [homepage](https://github.com/node-base/base "Framework for rapidly creating high quality node.js applications, using plugins like building blocks")
* [cache-base](https://www.npmjs.com/package/cache-base): Basic object cache with `get`, `set`, `del`, and `has` methods for node.js/javascript projects. | [homepage](https://github.com/jonschlinkert/cache-base "Basic object cache with `get`, `set`, `del`, and `has` methods for node.js/javascript projects.")
* [config-cache](https://www.npmjs.com/package/config-cache): General purpose JavaScript object storage methods. | [homepage](https://github.com/jonschlinkert/config-cache "General purpose JavaScript object storage methods.")
* [map-cache](https://www.npmjs.com/package/map-cache): Basic cache object for storing key-value pairs. | [homepage](https://github.com/jonschlinkert/map-cache "Basic cache object for storing key-value pairs.")
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
### Contributors
| **Commits** | **Contributor** |
| --- | --- |
| 95 | [jonschlinkert](https://github.com/jonschlinkert) |
| 2 | [tunnckoCore](https://github.com/tunnckoCore) |
### Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ 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:
```sh
$ npm install && npm test
```
### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on May 19, 2017._