memory-cache

A simple in-memory cache for node.js

Installation

npm install memory-cache --save

Usage

varcache=require('memory-cache');// now just use the cachecache.put('foo','bar');console.log(cache.get('foo'));// that wasn't too interesting, here's the good partcache.put('houdini','disappear',100,function(key,value){console.log(key+' did '+value);});// Time in msconsole.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

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 (only monitored in debug mode)

misses = function()

• Returns the number of cache misses (only monitored in debug mode)

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.