website/node_modules/map-cache/README.md

map-cache NPM version NPM downloads Build Status

Basic cache object for storing key-value pairs.

Install

Install with npm:

$ npm install map-cache --save

Based on MapCache in Lo-dash v3.0. MIT License

Usage

var MapCache = require('map-cache');
var mapCache = new MapCache();

API

MapCache

Creates a cache object to store key/value pairs.

Example

var cache = new MapCache();

.set

Adds value to key on the cache.

Params

Example

cache.set('foo', 'bar');

.get

Gets the cached value for key.

Params

Example

cache.get('foo');
//=> 'bar'

.has

Checks if a cached value for key exists.

Params

Example

cache.has('foo');
//=> true

.del

Removes key and its value from the cache.

Params

Example

cache.del('foo');

Related projects

You might also be interested in these projects:

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

This file was generated by verb, v0.9.0, on May 10, 2016.



JohnCoene/chirp documentation built on May 25, 2021, 6:33 p.m.