LRU-Cache

LRU Cache implementations in Node.js

Usage

const lru = require('LRU-Cache');

.set

capacity - the list capacity and 0 is not allowed, default: 1000
maxAge - the node will be destroyed by itself in maxAge ms

const cache = new lru({capacity: 100});
cache.set('test_key', 123);
cache.set('test_key', 234);
console.info(cache.toArray('test_key').length);
> 2

instance lru with maxAge

/* the node will be destroyed in 1000 ms one by one */
const cache = new lru({capacity: 100, maxAge: 1000});
cache.set('test_key', 123);
cache.set('test_key', 234);
console.info(cache.toArray('test_key').length);
> 0

.get

only the front node will be returned
key - the hash map key

const value = cache.get('test_key');
console.info(value === 234); // true

.toArray

key - the hash map key

const values = cache.toArray(key);
console.info(values); // [234, 123]

Test

npm run test

Coverage

LICENCE

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

danielsss / LRU-Cache