Basic cache object for storing key-value pairs.
npm install map-cacheBasic cache object for storing key-value pairs.
Install with npm:
``sh`
$ npm install map-cache --save
Based on MapCache in Lo-dash v3.0. MIT License
`js`
var MapCache = require('map-cache');
var mapCache = new MapCache();
Creates a cache object to store key/value pairs.
Example
`js`
var cache = new MapCache();
Adds value to key on the cache.
Params
* key {String}: The key of the value to cache.value
* {any}: The value to cache.returns
* {Object}: Returns the Cache object for chaining.
Example
`js`
cache.set('foo', 'bar');
Gets the cached value for key.
Params
* key {String}: The key of the value to get.returns
* {any}: Returns the cached value.
Example
`js`
cache.get('foo');
//=> 'bar'
Checks if a cached value for key exists.
Params
* key {String}: The key of the entry to check.returns
* {Boolean}: Returns true if an entry for key exists, else false.
Example
`js`
cache.has('foo');
//=> true
Removes key and its value from the cache.
Params
* key {String}: The key of the value to remove.returns
* {Boolean}: Returns true if the entry was removed successfully, else false.
Example
`js`
cache.del('foo');
You might also be interested in these projects:
* cache-base: Basic object cache with get, set, del, and has methods for node.js/javascript projects. | homepage
* config-cache: General purpose JavaScript object storage methods. | homepage
* option-cache: Simple API for managing options in JavaScript applications. | homepage
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Generate readme and API documentation with verb:
`sh`
$ npm install verb && npm run docs
Or, if verb is installed globally:
`sh`
$ verb
Install dev dependencies:
`sh``
$ npm install -d && npm test
Jon Schlinkert
* github/jonschlinkert
* twitter/jonschlinkert
Copyright © 2016, Jon Schlinkert.
Released under the MIT license.
*
_This file was generated by verb, v0.9.0, on May 10, 2016._