What is map-cache?
The map-cache npm package is a simple cache to store key-value pairs. It is particularly useful for storing the results of expensive function calls or any other calculations that you don't want to repeat unnecessarily. It's a lightweight and fast caching solution.
What are map-cache's main functionalities?
Set and Get Values
This feature allows you to store a value with a specific key and then retrieve that value using the key.
{"const MapCache = require('map-cache');
const cache = new MapCache();
cache.set('foo', 'bar');
const value = cache.get('foo');
console.log(value); // Output: 'bar'"}
Check Existence of Key
This feature allows you to check if a key exists in the cache.
{"const MapCache = require('map-cache');
const cache = new MapCache();
cache.set('foo', 'bar');
const hasKey = cache.has('foo');
console.log(hasKey); // Output: true"}
Delete a Key
This feature allows you to delete a key-value pair from the cache.
{"const MapCache = require('map-cache');
const cache = new MapCache();
cache.set('foo', 'bar');
cache.delete('foo');
const value = cache.get('foo');
console.log(value); // Output: undefined"}
Clear the Cache
This feature allows you to clear all key-value pairs stored in the cache.
{"const MapCache = require('map-cache');
const cache = new MapCache();
cache.set('foo', 'bar');
cache.clear();
const value = cache.get('foo');
console.log(value); // Output: undefined"}
Other packages similar to map-cache
lru-cache
lru-cache is an npm package that implements a cache object that deletes the least-recently-used items. It is similar to map-cache but with the added feature of maintaining a limited size and evicting entries that have not been recently used.
node-cache
node-cache is an in-memory cache module for Node.js. It is similar to map-cache but provides additional features like TTL (time to live) for entries, statistics about the cache's performance, and events for when entries expire.
memory-cache
memory-cache is another simple in-memory cache for Node.js applications. It is similar to map-cache but also offers the ability to set a timeout on cached items, after which they are automatically removed.
map-cache
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
Creates a cache object to store key/value pairs.
Example
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
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
cache.get('foo');
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');
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');
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.