map-lru

MapLRU

"Least Recently Used" (LRU) cache compatible to ES6 Map

Useful for caching with limited memory usage. API compatible with built-in Map object.

Install

$ npm install map-lru

Usage

import MapLRU from 'map-lru' // ES5
// const MapLRU = require('map-lru') // commonJs
const cache = new MapLRU(10)

cache.set('♥', '♥♥♥')

cache.has('♥');
//=> true
cache.get('♥');
//=> '♥♥♥'
cache.last
//=> '♥'
cache.size
//=> 1

API

new MapLRU(maxSize)

Creates a new instance

Parameters

• maxSize Number max. size of the LRU cache.

---

Additional methods

• last

  Returns the last accessed key.

  Returns Any

• peek(key)

  Get an item without marking it as recently used.

  Parameters

  • key Any

• keysAccessed()

  keys in order of access - last one is most recently used one.

  Returns Iterator Iterator object

---

Default Map methods

• size

• get(key)

• set(key, value)

• has(key)

• delete(key)

• clear()

• keys()

• values()

• entries()

• forEach()

• [Symbol.iterator]

License

Unlicense