# @btravstack/cache 中文文档

规范地址：https://npmcn.com/package/%40btravstack/cache/

版本：0\.58\.0
npm 元数据更新时间：2026-11-07T21:14:07.083Z
中文译文更新时间：2026-11-08T18:14:20.474Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：56.7 kB，15 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：0 个
- peer 依赖：redis ^6\.2\.0，unthrown ^5\.0\.0，@btravstack/di ^0\.58\.0，@btravstack/core ^0\.58\.0，@btravstack/config ^0\.58\.0
- 首次发布：2026-08-25T16:22:58.357Z
- 最新版本发布：2026-11-07T21:14:06.782Z
- 近 30 天下载量：5903（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：62（近 12 个月 62 个）

## 中文简介

@btravstack/ Core 的缓存端口:内嵌适配器、 Redis 适配器、 向观察者报告每次呼叫的组件

## 安装

```sh
npm install @btravstack/cache
```

也可以使用：`pnpm add @btravstack/cache`、`yarn add @btravstack/cache`、`bun add @btravstack/cache`

## README

# @ btravstack/ cach

> 缓存端口用于 [`@btravstack/core`](https://npmcn.com/package/%40btravstack/core)页:1 `Cache` 申请 取决于背后的记忆和Redis适配器 以及选择进入 每一次通话的间隔、计数和记录.

📖 **[文档](https://btravstack.github.io/btravstack/reference/cache)** • 妇女 [API 参考](https://btravstack.github.io/btravstack/api/cache/)

```sh
pnpm add @btravstack/cache @btravstack/core @btravstack/config @btravstack/di unthrown
```

4个同伴依赖关系,加 `redis` ——可选的,只有你需要 作"雷地斯"适配器. 仪器不需要自己的同伴: `Logger`, (中文(简体) ), `Tracer` 财务报告和审定财务报表 `Meter` 这取决于是 [内核的端口](https://btravstack.github.io/btravstack/reference/core/observability), (中文(简体) ), 财务报告和审定财务报表 `@btravstack/observability` 申请是用来满足的 他们。 节点 `>=22`。 。 。 .

## 实例

一个读取,这是一个呼吁——退化政策生活在港口:

```ts
import { Cache } from "@btravstack/cache";
import { Port, Provider } from "@btravstack/di";
import type { AsyncResult } from "unthrown";

class Customers extends Port("ReadmeCustomers")<{
  readonly find: (
    tenantId: string,
    id: string,
  ) => AsyncResult<CustomerView, CustomerNotFound>;
}> {}

const customers = Provider(Customers)({
  inject: { find: FindCustomer, cache: Cache },
  sync: ({ find, cache }) => ({
    find: (tenantId, id) =>
      cache.getOrSet<CustomerView, CustomerNotFound>(
        // The key carries the tenant, because the port does not: `Cache` takes
        // plain strings, and composing them is the application's job.
        `customers:${tenantId}:${id}`,
        () => find.execute(TenantId(tenantId), id).map(view),
        { ttlMs: 60_000 },
      ),
  }),
});
```

而成分——适配器是唯一的决定:

```ts
import { cache } from "@btravstack/cache";
import { redisCache } from "@btravstack/cache/redis";

export const CustomersApp = Module("CustomersApp")({
  imports: [
    CustomerApplicationModule,
    CustomerPersistenceModule,
    // Every call is reported through `Observers`. Drop the two modules
    // below and this composition is unchanged — it just reports to nobody.
    cache({ adapter: redisCache() }),
    observability(),
    otel(),
  ],
  provides: [customers],
  exports: [Customers, Logger],
});
```

## 选项

| 选项 | 何处 | 这是什么 |
| --- | --- | --- |
| `adapter` | `cache({ adapter })` | 适配器模块提供 `CacheBackend` 所需数额 |
| `clock` | `memoryCache` | 计算 ttl 相对于什么( 默认: 内核) `systemClock`(中文(简体) ) |
| `REDIS_URL` | 环境,读作 `redisCache()` | 连接 URL — 需要, 在图表构建中验证 |
| `ttlMs` | `cache.set` 编号 : `cache.getOrSet` | 每入为过期, 四舍五入为整毫秒( 默认: 无) —— 条目在被删除或被删除之前将保留; 一个值不四舍五入为整毫秒的至少 1 表示条目没有被存储, 所以 `0.6` 保存为 `1` 财务报告和审定财务报表 `0.4` 完全没有存储) |

完整表——默认,语义和推理——活在 [参考页](https://btravstack.github.io/btravstack/reference/cache), (中文(简体) ), 这张名单是详细的.

## 它决定什么,它没有

**决定** 错过的是 `Ok(undefined)` 绝不然,那确是失败的 后端为模型 `CacheUnavailable` 而不是一个被吞噬的 值为 `unknown` 由适配器编码, 而密钥是普通字符串 召者作会.

**它决定一件事给你**:每通电话都通过 `Observers`不需要接受这些报告——一个图表 没有可观察性汇编,开始和支付一个惰性呼叫——所以决定 您需要一个端口列表, 前提是您想要跨度和仪器, 然后 你编曲 `observability()` 财务报告和审定财务报表 `otel()` 和改变什么在这里.

**它没有决定** 无法获取的缓存是否降解 a `get` ——恢复 `CacheUnavailable` 你叫它的地方 钥匙是什么样子 什么时候 以使他们失效。 它决定的地方是 `getOrSet`时 无法到达的缓存运行您的加载器, 而失败的写入不是您的错误 。 那边 没有印花保护,没有驱逐内存适配器,也没有命名空间 参数 - 每个原因都在 [参考页](https://btravstack.github.io/btravstack/reference/cache), (中文(简体) ), 同样的推理是 [`AGENTS.md`](https://npmcn.com/package/%40btravstack/cache/AGENTS.md) 用于贡献者.

## 许可证

麻省理工学院

## 常见问题

### @btravstack/cache 是什么？

@btravstack/ Core 的缓存端口:内嵌适配器、 Redis 适配器、 向观察者报告每次呼叫的组件

### 如何安装 @btravstack/cache？

在项目目录运行 npm install @btravstack/cache，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：unthrown（^5\.0\.0）、@btravstack/di（^0\.58\.0）、@btravstack/core（^0\.58\.0）、@btravstack/config（^0\.58\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @btravstack/cache 支持 TypeScript 吗？

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

### @btravstack/cache 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @btravstack/cache 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @btravstack/cache 可以商用吗？

@btravstack/cache 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @btravstack/cache 的下载量有多少？

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

### @btravstack/cache 还在维护吗？

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