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.
const cache = lru(max, ttl = 0);Lodash provides a memoize function with a cache that can be swapped out as long as it implements the right interface.
See the lodash docs for more on memoize.
Example
_.memoize.Cache = lru().constructor;
const memoized = _.memoize(myFunc);
memoized.cache.max = 10;clear
Method
Clears the contents of the cache
return {Object} LRU instanceExample
cache.clear();delete
Method
Removes item from cache
param {String} key Item key
return {Object} LRU instanceExample
cache.delete("myKey");evict
Method
Evicts the least recently used item from cache
return {Object} LRU instanceExample
cache.evict();first
Property
Item in "first" or "top" position
Example
const 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 valueExample
const item = cache.get("myKey");keys
Method
Returns an Array of cache item keys.
return {Array} Array of keysExample
console.log(cache.keys());max
Property
Max items to hold in cache (1000)
Example
const cache = lru(500);
cache.max; // 500last
Property
Item in "last" or "bottom" position
Example
const cache = lru();
cache.last; // null - it's a new cache!length
Property
Number of items in cache
Example
const cache = lru();
cache.length; // 0 - it's a new cache!remove
Method
(Deprecated) Removes item from cache
param {String} key Item key
return {Object} LRU instanceExample
cache.remove("myKey");set
Method
Sets item in cache as first
param {String} key Item key
param {Mixed} value Item value
return {Object} LRU instanceExample
cache.set("myKey", {prop: true});ttl
Property
Milliseconds an item will remain in cache; lazy expiration upon next get() of an item
Example
const cache = lru();
cache.ttl = 3e4;License
Copyright (c) 2019 Jason Mulligan Licensed under the BSD-3 license.