@godspeedai/cognate-projections

中文文档
0.10.0发布于 2026/11/16Apache-2.0ES Module构建来源已验证近 30 天下载 4970

对耐久事件日志(spec §11)进行了检查、一手和可重建的预测.

中文使用文档
文档目录6 节
  1. 安装
  2. 快开始
  3. 跑者的行为
  4. 限制
  5. 相关软件包
  6. 许可证

@godspideai/ cognate- projections

经检查,能分解,可重建的对Cognate持久事件日志的预测. 预测是事件产生的决定性因素; ProjectionRunner 保持其衍生状态和检查站同步,逐批进行,决不跳过故障事件.

何时使用此软件包 : 您想要从已承诺的事件中得出的读取模型或索引——计数,列表,每个租户的视图——在重启后存活下来,可以从零开始重建,并在同时编剧下保持一致. 这个 @godspeedai/cognate-runtime-bun 运行时间使用此软件包来保持已注册的预测流; 您也可以运行一个 ProjectionRunner 直接覆盖任意 @godspeedai/cognate-events 存储.

安装

bun add @godspeedai/cognate-projections

要求数 阿宝 1.4.0 需要一个执行 @godspeedai/cognate-events DurableStore 合同——例如 @godspeedai/cognate-store-sqlite 或者说 @godspeedai/cognate-store-memory。 。 。 .

快开始

import { ProjectionRunner } from "@godspeedai/cognate-projections";
import type { Projection } from "@godspeedai/cognate-projections";

const ledger: Projection = {
  name: "ledger",
  version: "1", // bump to force a rebuild rather than reinterpret old state
  apply(event, state) {
    const count = (state.get(`count:${event.eventType}`) as number | undefined) ?? 0;
    const total = (state.get("total") as number | undefined) ?? 0;
    const amount = (event.payload as { amount?: number }).amount ?? 0;
    return [
      { key: `count:${event.eventType}`, value: count + 1 },
      { key: "total", value: total + amount },
    ];
  },
};

const runner = new ProjectionRunner(store, ledger);
const result = await runner.catchUp();
// { status: "ok", position: <last applied store position>, applied: 3 }

const total = await store.readProjection("ledger", "total");

apply 返回要写的密钥(value: null 删除密钥),并可能读取同一批次中较早时写入的状态 state.get。 。 。 .

跑者的行为

  • 检出并一等能. 每批的文字和检查点 都通过一个解剖方式 commitProjection 呼叫,由前阵地守卫 运行 catchUp() 两次应用每个事件一次.
  • 失败阻止了世界,这是正确的. 在应用错误中, 运行者执行成功的前缀, 记录失败事件时的错误, 然后返回 { status: "error", ... }。 。 。 . catchUp() 继续返回存储的错误,直到您清除它 retry()重新尝试从检查站。 失败的事件永远不会被跳过 .
  • 版本更改需要重建. 一个存储的检查点,其版本与投影本身的产量不同 { status: "rebuild_required" }· ; rebuild() 删除派生状态并重放位置0.
  • 直播模式. start() 跟踪所犯之事; stop() 在飞行中运行结束后取消订阅 。 所有运行——直播, catchUp, (中文(简体) ), retry, (中文(简体) ), rebuild ——被序列化,使其永不重叠. waitFor(position) 一旦检查站到达指定的商店位置,即可解决.
  • 同时期跑者是安全的. 两名跑者在一次投影比赛上通过商店的检查站冲突解决:输家重新读取检查站,并从中继续而无需双重应用.

限制

  • 预测是推导出来的状态:这里没有什么是权威的 rebuild() 将愉快地删除和重算一切。 永远不要在投影中存储唯一的数据副本.
  • apply 考虑到事件和状态——没有时钟、随机性或网络——必须具有决定性。 首先将非决定性输入记录为事件 .

许可证

阿帕奇 - 2.0

版本与发布记录

@godspeedai/cognate-projections 共发布 20 个版本,首次发布于 2026/10/09;过去 12 个月发布了 20 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.10.0latest2026/11/16今天
0.9.22026/11/152 天前
0.9.12026/11/143 天前
0.9.02026/11/0610 天前
0.8.02026/10/2720 天前
0.7.12026/10/2523 天前

关于 @godspeedai/cognate-projections 的常见问题

@godspeedai/cognate-projections 是什么?

对耐久事件日志(spec §11)进行了检查、一手和可重建的预测.

如何安装 @godspeedai/cognate-projections?

在项目目录运行 npm install @godspeedai/cognate-projections,或使用 pnpm add / yarn add / bun add。

@godspeedai/cognate-projections 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/godspeedai__cognate-projections 是否存在。

@godspeedai/cognate-projections 支持 ESM 还是 CommonJS?

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

@godspeedai/cognate-projections 可以商用吗?

@godspeedai/cognate-projections 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@godspeedai/cognate-projections 的下载量有多少?

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

@godspeedai/cognate-projections 还在维护吗?

最新版本 0.10.0 发布于 2026/11/16(今天);至今共发布 20 个版本,其中过去 12 个月发布了 20 个;首次发布于 2026/10/09。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。