Socket
Socket
Sign inDemoInstall

lru

Package Overview
Dependencies
0
Maintainers
1
Versions
16
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    lru

A simple O(1) LRU cache


Version published
Maintainers
1
Install size
10.9 kB
Created

Readme

Source

lru

A simple LRU cache supporting O(1) set, get and eviction of old keys

Installation

$ npm install lru

Example

var LRU = require('lru').LRU;

var cache = new LRU(2),
    evicted

cache.on('evict',function(data) { evicted = data });

cache.set('foo', 'bar');
cache.get('foo'); //=> bar

cache.set('foo2', 'bar2');
cache.get('foo2'); //=> bar2

cache.set('foo3', 'bar3');
cache.get('foo3'); //=> bar3,  evicted = { key: 'foo', value: 'bar' }

API

require('lru').LRU( length )

Create a new LRU cache that stores length elements before evicting the least recently used.

Returns: the newly created LRU cache

Methods
.set( key, value )

Set the value of the key and mark the key as most recently used.

Returns: value

.set( key, value )

Set the value of the key and mark the key as most recently used.

.get( key )

Query the value of the key and mark the key as most recently used.

Returns: value of key if found; undefined otherwise.

.on( event, callback )

Respond to events. Currently only the evict event is implemented. When a key is evicted, the callback is executed with an associative array containing the evicted key: {key: key, value: value}.

Credits

A big thanks to Dusty Leary who finished the library.

License

MIT

FAQs

Last updated on 01 Jul 2015

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc