LRU缓存库技术文档

安装指南

要安装lru-cache库，请在终端中运行以下命令：

npm install lru-cache --save

项目使用说明

lru-cache是一个用于删除最近最少使用项的缓存对象。你可以指定要保留的最大最近使用项数量，缓存将保留这些最近访问的项。

基本用法

import { LRUCache } from 'lru-cache'

const options = {
  max: 500, // 最大缓存项数
  ttl: 1000 * 60 * 5, // 缓存项的生存时间（毫秒）
}

const cache = new LRUCache(options)

cache.set('key', 'value')
cache.get('key') // "value"

非字符串键的支持

lru-cache支持非字符串键，但需要注意的是，键必须是相同的对象，而不是仅具有相同键值的JSON等效对象。

var someObject = { a: 1 }
cache.set(someObject, 'a value')
assert.equal(cache.get(someObject), 'a value')
assert.equal(cache.get({ a: 1 }), undefined) // 不同的对象身份

清空缓存

cache.clear() // 清空缓存

项目API使用文档

class LRUCache<K, V, FC = unknown>(options)

创建一个新的LRUCache对象。

选项

• max (只读): 缓存中保留的最大项数。
• maxSize (只读): 用于跟踪项的大小，并自动逐出项以保持在指定大小以下。
• maxEntrySize: 用于跟踪项的大小，并防止缓存超过指定大小的项。
• sizeCalculation: 用于计算存储项大小的函数。
• fetchMethod (只读): 用于进行后台异步获取的函数。
• noDeleteOnFetchRejection: 如果fetchMethod抛出错误或返回被拒绝的Promise，则默认情况下，任何现有的陈旧值将从缓存中删除。
• allowStaleOnFetchRejection: 设置为true以在fetchMethod抛出错误或返回被拒绝的Promise时从缓存中返回陈旧值。
• allowStaleOnFetchAbort: 设置为true以在AbortSignal传递给fetchMethod时返回缓存中的陈旧值。
• ignoreFetchAbort: 设置为true以忽略fetchMethod的abort事件，并仍然缓存结果值。

项目安装方式

通过npm安装：

npm install lru-cache --save

安装后，你可以通过以下方式导入和使用：

import { LRUCache } from 'lru-cache'
// 或者
const { LRUCache } = require('lru-cache')

通过以上步骤，你可以成功安装并使用lru-cache库。