Decentralized “Least Recently Used” (LRU) cache
Experimental Fork of Quick-LRU powered by the Hyper Protocol
Hyper-LRU instances can discover each other using DHT topics and exchange cache events with the swarm.
Hyperswarm diagram by @mafintosh
$ npm install hyper-lru
const HyperLRU = require('hyper-lru');
// Start multiple instances of HyperLRU on different hosts
const lru1 = new HyperLRU({maxSize: 100, hyper: 'mysupersecretlonghash' });
const lru2 = new HyperLRU({maxSize: 100, hyper: 'mysupersecretlonghash' });
// Cache using the 1st LRU
lru1.set('🦄', '🌈');
lru1.has('🦄');
//=> true
lru1.get('🦄');
//=> '🌈'
// Query using the 2nd LRU
lru2.has('🦄');
//=> true
lru2.get('🦄');
//=> '🌈'Returns a new instance.
Type: object
Required
Type: number
The maximum number of items before evicting the least recently used items.
Optional
Type: (key, value) => void
Called right before an item is evicted from the cache.
Useful for side effects or for items like object URLs that need explicit cleanup (revokeObjectURL).
The instance is an Iterable of [key, value] pairs so you can use it directly in a for…of loop.
Both key and value can be of any type.
Set an item. Returns the instance.
Get an item.
Check if an item exists.
Get an item without marking it as recently used.
Delete an item.
Returns true if the item is removed or false if the item doesn't exist.
Delete all items.
Update the maxSize, discarding items as necessary. Insertion order is mostly preserved, though this is not a strong guarantee.
Useful for on-the-fly tuning of cache sizes in live systems.
Iterable for all the keys.
Iterable for all the values.
Iterable for all entries, starting with the oldest (ascending in recency).
Iterable for all entries, starting with the newest (descending in recency).
The stored item count.