# @dbx-tools/cache 中文文档

规范地址：https://npmcn.com/package/%40dbx-tools/cache/

版本：0\.9\.206
npm 元数据更新时间：2026-11-10T19:18:44.918Z
中文译文更新时间：2026-11-11T17:23:34.361Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40dbx-tools/cache
原文对照：https://npmcn.com/package/%40dbx-tools/cache/?lang=original
项目主页：https://github.com/reggie-db/dbx-tools#readme
源码仓库：https://github.com/reggie-db/dbx-tools

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：108 kB，10 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：6 个
- 首次发布：2026-10-12T08:00:19.067Z
- 最新版本发布：2026-11-10T19:18:44.521Z
- 近 30 天下载量：11009（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：65（近 12 个月 65 个）

## 中文简介

内存首个可缓存和 Keyv 存储, 并有项目扫描的持久性和跟踪的后置写

## 安装

```sh
npm install @dbx-tools/cache
```

也可以使用：`pnpm add @dbx-tools/cache`、`yarn add @dbx-tools/cache`、`bun add @dbx-tools/cache`

## README

# @dbx-工具/缓存

带有可选工程瞄准镜的捆绑内存中的缓存节点.js 和 Bun 值 磁盘或 Keyv相容的持久性 。 前面写着别等了 并且关闭可以排出追踪到的文字.

## 缓存项目数据

```ts
import { closeCache, getOrSet, projectCache } from "@dbx-tools/cache/cache";

const cache = projectCache("models", { ttl: "5m" });
const models = await getOrSet(cache, "catalog", loadModels, {
  returnCachedOnError: true,
});

await closeCache(cache);
```

`projectCache` 在此过程中再使用同一命名的缓存 。 打电话 `closeCache` 在程序关闭以冲出待定磁盘时.

## 在不阻塞的情况下刷新热值

设定 `refreshAfterWrite` 当呼叫者继续收到当前值时 而一个同步重装更新它。 持续时间取决于缓存 值 :

```ts
const enabled = await getOrSet(cache, "smart-router", probeSmartRouter, {
  ttl: "2h",
  refreshAfterWrite: (value) => (value ? "5m" : "30s"),
});
```

装填器的首个缺失块. 之后 `refreshAfterWrite`,下一个访问 立即返回缓存值,并启动一个连接后的背景更新. 未使用的条目不刷新,以及 `ttl` 仍然很难结束。 A 类 失败的背景刷新 . `closeCache()` 等待时间 在断开持久性之前进行活动更新 .

## 创建一个仅保存内存的缓存

使用 `createCache` 数值应保持局部到 当前进程:

```ts
import { closeCache, createCache } from "@dbx-tools/cache/cache";

const cache = createCache({ maxEntries: 250, ttl: "30s" });
await cache.set("health", { status: "ready" });

await closeCache(cache);
```

命令的 Keyv 兼容 `levels` 改为 `createCache` 应用程序需要时 自定义持久性。 软件包不依赖于 AppKit; `@dbx-tools/appkit` 适应 AppKit 的存储合同. 软件包拥有Keyv运行时间,所以消费者不会安装或将Keyv钉入到 对齐缓存构建器.

## 限制

内存级别是进程本地化的,不是跨replica协调 机制。 打电话 `closeCache()` 在关闭时,当以后的水平必须收到时 待定写作。 使用共享的 Keyv 兼容级别或自有框架 当复制品必须读取相同的持续值时,可分配缓存.

## 常见问题

### @dbx-tools/cache 是什么？

内存首个可缓存和 Keyv 存储, 并有项目扫描的持久性和跟踪的后置写

### 如何安装 @dbx-tools/cache？

在项目目录运行 npm install @dbx-tools/cache，或使用 pnpm add / yarn add / bun add。

### @dbx-tools/cache 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @dbx-tools/cache 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @dbx-tools/cache 可以商用吗？

@dbx-tools/cache 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @dbx-tools/cache 的下载量有多少？

根据 npm 官方下载统计，@dbx-tools/cache 在 2026/10/12 – 2026/11/10 这 30 天内被下载 11,009 次，日均约 367 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @dbx-tools/cache 还在维护吗？

最新版本 0\.9\.206 发布于 2026/11/11（今天）；至今共发布 65 个版本，其中过去 12 个月发布了 65 个；首次发布于 2026/10/12。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。