Big update!Announcing Socket for GitHub 1.0. Learn more
Socket
BlogLoveFAQ
Install
Log in

map-cache

Package Overview
Dependencies
0
Maintainers
1
Versions
5
Issues
File Explorer

Advanced tools

map-cache

Basic cache object for storing key-value pairs.

    0.2.2latest

Version published
Maintainers
1
Weekly downloads
18,627,734
decreased by-3.75%

Weekly downloads

Readme

Source

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

  • key {String}: The key of the value to cache.
  • value {any}: The value to cache.
  • returns {Object}: Returns the Cache object for chaining.

Example

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

.get

Gets the cached value for key.

Params

  • key {String}: The key of the value to get.
  • returns {any}: Returns the cached value.

Example

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

.has

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

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

.del

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

cache.del('foo');

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.

Keywords

FAQs

What is map-cache?

Basic cache object for storing key-value pairs.

Is map-cache popular?

The npm package map-cache receives a total of 15,644,136 weekly downloads. As such, map-cache popularity was classified as popular.

Is map-cache well maintained?

We found that map-cache demonstrated a not healthy version release cadence and project activity because the last version was released a year ago.It has 1 open source maintainer collaborating on the project.

Last updated on 10 May 2016
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc