memoize-cache

memoize-cache

A configurable cache support for memoized functions. It is lightweight so it can run in the browser without any problem.

A note about the API

This is an in-memory cache implementation. But the interface is designed to work with an external storage support (db, etc). The only 2 required public methods are: "push" and "query".

Creating an instance

The constructor takes an option object with 3 optional attributes:

• key: a function used to extract the cache key (used in the push and query method for storing, retrieving the cached value). The key returned should be a string or it will be converted to JSON and then md5. Default: a function returning a fixed key.
• maxAge: the maximum age of the item stored in the cache (in ms). Default: Infinity
• maxLen: the maximum number of items stored in the cache. Default: Infinity. Cache items will be purged using an LRU algorithm

Example:

var Cache = require('memoize-cache/ram-cache'); // or require('memoize-cache').ramCache;

// no values, uses always the same key for store any value
var cache = new Cache();

// using the id property of the first argument
// this cache will store maximum 100 items
// every item will be considered stale and purged after 20 seconds.
var cache = new Cache({key: function (config){
  return config.id;
}}, maxLen: 100, maxAge: 20000);

Pushing a new cached value

cache.push(args, output);

"args" is an array containing the arguments passed to the function that generated the output.

Querying for cache hit

cache.query(args, function (err, result){
  // result.cached is true when you find a cached value
  // result.hit is the value cached
  // cached.key is the key used to store the value (might be useful for debugging)
});

"args" is an array containing the arguments passed to the function that generated the output.

resetting the cache

cache.reset();

getting the number of item cached

cache.len();

getting the size of the cache

cache.size(true);  // size is an human readable size

cache.size(false); // size is expressed in byte

If the first argument is true the output will be pretty printed.