An expiring LRU cache module for node.js. This builds on the lru-cache module.

Usage

var Cache = require('expiring-lru-cache');

// Create a cache for up to 100 items (size). Items expire in 5 minutes
// (300 seconds expiry).
var accountCache = new Cache({size: 100, expiry: 300});
accountCache.set('hamish', {...});
...
accountCache.get('hamish')    // => {...}

This also supports logging using Bunyan:

var Logger = require('bunyan');
var log = new Logger({name: 'myapp' /*, ... */});

// 'name' is optional. It will be included in logging to help identify
// the cache.
var requestCache = new Cache({size: 50, expiry: 60,
        log: log, name: 'request'});
requestCache.set('a', 1)
requestCache.get('a')       // => 1

This will then log at the TRACE level any cache usage:

XXX examples

Installation

npm install expiring-lru-cache

License

MIT. See LICENSE.txt.

API

cache.set(key, value)
cache.get(key) -> value
cache.del(key)
cache.reset()