easy-memory-cache

An easy in-memory cache for node.js, based and forked from Memory-cache

Installation

npm install easy-memory-cache --save

Usage

var cache = require('memory-cache');

// now just use the cache
cache.put('foo', 'bar');
console.log(cache.get('foo'));

// that wasn't too interesting, here's the good part

cache.put('houdini', 'disappear', 100, function(key, value) {
    console.log(key + ' did ' + value);
}); // Time in ms

console.log('Houdini will now ' + cache.get('houdini'));

setTimeout(function() {
    console.log('Houdini is ' + cache.get('houdini'));
}, 200);

which should print

bar
Houdini will now disappear
Houdini did disappear
Houdini is null

API

createCache = function()

• The function createCache on the global cache object, creates a completely new instance of the cache.
• Returns the new cache instance.

put = function(key, value, time, timeoutCallback)

• Simply stores a value
• If time isn't passed in, it is stored forever
• Will actually remove the value in the specified time in ms (via setTimeout)
• timeoutCallback is optional function fired after entry has expired with key and value passed (function(key, value) {})
• Returns the cached value

get = function(key)

• Retrieves a value for a given key
• If value isn't cached, returns null

del = function(key)

• Deletes a key, returns a boolean specifying whether or not the key was deleted

clear = function()

• Deletes all keys

size = function()

• Returns the current number of entries in the cache

memsize = function()

• Returns the number of entries taking up space in the cache
• Will usually == size() unless a setTimeout removal went wrong

debug = function(bool)

• Turns on or off debugging

hits = function()

• Returns the number of cache hits

misses = function()

• Returns the number of cache misses

keys = function()

• Returns all the cache keys

Note on Patches/Pull Requests

• Fork the project.
• Make your feature addition or bug fix.
• Send me a pull request.