@swarmy/lru-cache

lru-cache

A Javascript LRU-cache for node and/or browser, featuring:

• LRU cache logic
• Singleton caches per value type
• Event registry for cache change events

Installation

npm install --save @swarmy/lru-cache

Basic Usage

Caching

import {getCache} from "@swarmy/lru-cache";
// If you use in nodejs and prefer the old-fashioned way:
// var getCache = require("@swarmy/lru-cache").getCache;

...
const userCache = getCache("User");
userCache.set(user.id, user);
...
let user = userCache.get(userId);
if (!user) {
    await fetchUser(userId);
}

• For the same value type (here "User"), getCache will always return the same cache instance.
• For detailed description of all cache methods, have a look at
  • Detailed Usage
  • JSDoc

Cache Events

WIP

Quality

• Test results
• Test coverage

Develop

git clone https://github.com/gneu77/lru-cache.git
cd lru-cache
npm install
// no you can do:
npm run build
npm run test
npm run generate-doc

Detailed Usage

Caching

WIP

Cache Events

WIP