JSPM

  • Created
  • Published
  • Downloads 1128420
  • Score
    100M100P100Q185075F

Tiny LRU cache for Client or Server

Package Exports

  • tiny-lru
  • tiny-lru/lib/tiny-lru

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tiny-lru) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Tiny LRU

Least Recently Used cache for Client or Server.

build status

var cache = lru(500);

evict

Method

Evicts the least recently used item from cache

return {Object} LRU instance

Example

cache.evict();

first

Property

Item in "first" or "top" position

Example

var cache = lru();

cache.first; // null - it's a new cache!

get

Method

Gets cached item and moves it to the front

param  {String} key Item key
return {Mixed}      Undefined or Item value

Example

var item = cache.get("myKey");

items

Property

Hash of cache items

Example

var cache = lru();

cache.items; // {}

max

Property

Max items to hold in cache (1000)

Example

var cache = lru(500);

cache.max; // 500

last

Property

Item in "last" or "bottom" position

Example

var cache = lru();

cache.last; // null - it's a new cache!

length

Property

Number of items in cache

Example

var cache = lru();

cache.length; // 0 - it's a new cache!

remove

Method

Removes item from cache

param  {String} key Item key
return {Object}     Item

Example

var staleItem = cache.remove("myKey");

set

Method

Sets item in cache as first

param  {String} key   Item key
param  {Mixed}  value Item value
return {Object}       LRU instance

Example

cache.set("myKey", {prop: true});

License

Copyright (c) 2013 Jason Mulligan
Licensed under the BSD-3 license.