[go: up one dir, main page]

map-lru
TypeScript icon, indicating that this package has built-in type declarations

2.1.0 • Public • Published

MapLRU

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

NPM version Build Status Coverage Status

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

License

Unlicense

Dependencies (0)

    Dev Dependencies (8)

    Package Sidebar

    Install

    npm i map-lru

    Weekly Downloads

    1,256

    Version

    2.1.0

    License

    Unlicense

    Unpacked Size

    20.6 kB

    Total Files

    6

    Last publish

    Collaborators

    • commenthol