lru-dict

lru-dict is fast lru cache

LRUDict

Classic lru cache

LRUDict new LRUDict([Number size])

Creates new lru-cache instance

var LRUDict = require('lru-dict');
var cache = new LRUDict(7000);

The only constructor's arguments is size. Size is optional. The cache is unbounded if size omitted.

LRUDict cache.set(String key, * value)

Adds new entry to cache

cache.set('foo', 42);

* cache.get(String key)

Retrieves a value from cache by key

var value = cache.get('foo');

Boolean cache.del(String key)

Deletes value from cache by key

cache.set('foo', 42);
cache.get('foo'); // 42
cache.del('foo'); // true
cache.get('foo'); // undefined

Array<String> cache.keys()

Retrieves all the keys of cache in most used order

cache.set('foo', 42);
cache.keys(); // ['foo']

* cache.peek(String key)

Retrieves value from cache by key, but no change most used order

var cache = new LRUDict(2);
cache.set('foo', 42);
cache.set('bar', 43);
cache.get('foo');
cache.set('zot', 44);
cache.keys(); // ['foo', 'zot']
//  but
var cache = new LRUDict(2);
cache.set('foo', 42);
cache.set('bar', 43);
cache.peek('foo');
cache.set('zot', 44);
cache.keys(); // ['bar', 'zot']

Array<*> cache.vals()

Retrieves all the values of cache in most used order

cache.set('foo', 42);
cache.vals(); // [42]

Number cache.size

Set or get cache maximum length

var cache = new LRUDict(3);
cache.size; // 3
cache.size = 1;
cache.size; // 1

Crops less used entries if new size less than current

Number cache.length

Set or get cache maximum length

var cache = new LRUDict(3);
cache.size; // 3
cache.length; // 0
cache.set('foo', 42);
cache.length; // 1

Crops less used entries if new length less than current

LICENSE MIT