高速缓存
安装
npm install lru-cache --save
使用
var LRU = require("lru-cache")
, options = { max: 500
, length: function (n, key) { return n * 2 + key.length }
, dispose: function (key, n) { n.close() }
, maxAge: 1000 * 60 * 60 }
, cache = new LRU(options)
, otherCache = new LRU(50) // 仅设置最大大小
cache.set("key", "value")
cache.get("key") // "value"
// 完全支持非字符串键
// 但是,必须是同一对象
// 和JSON同等的对象
var someObject = { a: 1 }
cache.set(someObject, 'a value')
// 对象键不是toString ()-ed
cache.set('[object Object]', 'a different value')
assert.equal(cache.get(someObject), 'a value')
// 具有相同键/值的相似对象将不起作用,
// 因为是其它对象的ID
assert.equal(cache.get({ a: 1 }), undefined)
cache.reset() // 清空缓存
选项
max:
缓存内容数量
默认Infinity(无限大),
设置为非数字或负数TypeError,设置为0Infinity(无限大)
maxAge:
缓存全局过期时间(ms)
如果是过久的内容就会被删除返回undefined,设置为非数字TypeError
length:
用于计算存储项目长度的一种函数
存储字符串或缓冲区function(n, key){return n.length},
默认值function(){return 1}
dispose:
缓存被删除时的回调函数,接收缓存的 key, value 作为参数stale:默认的
get(key)时,返回数值
如果设置了maxAge,只有
如果设置stale:true, 在删除前,返回数值
如果没有设置这个值, 那么当get(key)时,返回undefined , 因为已经被删除noDisposeOnSet:默认的
dispose()方法,那么什么时候
如果设置了set()
,就重写已有的键
如果设定这个选项,dispose()只有从缓存中删除,不会被重写updateAgeOnGet:与maxAge一起使用
如果设置updateAgeOnGet
:true,更新内容时maxAge就会更新
API
-
set(key, value, maxAge)
-
get(key) => value
这两个都将更新键的“最近使用”状态
maxAge
是可选的,并覆盖提供的缓存maxAge
选项
如果找不到键,get()
将返回undefined
键和值可以是任何值 -
peek(key)
返回键值(或
undefined
找不到键),而不更新键的“最近使用”状态
(如果您发现自己经常使用它,则可能是使用了错误的数据结构,但是在某些用例中很方便) -
del(key)
从缓存中删除键
-
reset()
完全清除缓存,丢弃所有值
-
has(key)
检查键是否在缓存中,而不更新其最新性或将其过期删除
-
forEach(function(value,key,cache), [thisp])
就像
Array.prototype.forEach,
按照最新顺序对缓存中的所有键进行迭代
(即,首先迭代最近使用过的项) -
rforEach(function(value,key,cache), [thisp])
与相同,
cache.forEach(...),
但项目以相反的顺序迭代
(即,首先迭代最近使用较少的项目) -
keys()
返回缓存中的键数组
-
values()
返回缓存中的值数组
-
length
考虑
length
选项功能,返回缓存中对象的总长度 -
itemCount
返回当前在缓存中的对象总数
注意,stale
(请参阅选项)项目将作为该项目计数的一部分返回 -
dump()
返回准备好进行序列化和使用'destinationCache.load(arr)`的缓存条目数组
-
load(cacheEntriesArray)
将通过获取的另一个缓存条目数组加载
sourceCache.dump()
到缓存中,
在加载新条目之前,将重置目标缓存 -
prune()
手动遍历整个缓存,主动更新旧内容