# @asterql/store 中文文档

规范地址：https://npmcn.com/package/%40asterql/store/

版本：0\.5\.0
npm 元数据更新时间：2026-07-08T20:31:32.108Z
中文译文更新时间：2026-11-07T00:44:40.364Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：35 kB，8 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：1 个
- 首次发布：2026-06-11T01:35:36.548Z
- 最新版本发布：2026-07-08T20:31:32.002Z
- 近 30 天下载量：2516（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 4 个）

## 中文简介

规范化的实体存储,范围光标,以及用于AsterQL状态同步的查看-监视缓存.

## 安装

```sh
npm install @asterql/store
```

也可以使用：`pnpm add @asterql/store`、`yarn add @asterql/store`、`bun add @asterql/store`

## README

# @ asterql/ 仓库

```sh
npm install @asterql/store
```

AsterQL 的规范化实体存储、 范围光标和查看缓存 状态同步 。 这是客户端协议B的底物: 它摄入 `ServerEventEnvelope`从 `@asterql/view-protocol` 并保持一个确认 复制每个实体,同时执行 A 协议的查看缓存 停止资格政策,而不是取消资格.

心理模型(参见状态同步架构 doc):服务器拥有真理 和秩序; 客户拥有时间和意图; 观点拥有什么.

## API 密码

国家基数 :

-   `ScopeCursors`: 单声道入镜序列光标- `beginScope(scope, lastSeq)`, (中文(简体) ), `scopeLastSeq(scope)`,以及 `ingestSequenced(envelope, apply)` 返回时 `applied`, (中文(简体) ), `duplicate`,或 `gap`。光标即使在 `apply` 投出( 信封是 重置光标总是清晰的 所以 stale快照永远无法回溯到它已经应用过的序列中.
-   `CoalescedEmitter<TTopic>`: 微任务组合变化通知 全球、按专题和按键听众。 一个内的任何标记数 任务冲洗作为每个听众的单一通知.
-   `EntityStore`: 实现正常化 `EntityRecord` 映射已按键 `kind:id`时 `ingest(envelope)` 页:1 `patch`, (中文(简体) ), `snapshot`,以及 `invalidate` 信封 类型。 应用补丁通过 `applyEntityPatches`; 记录版本来 从信封或 `hashRecordVersion`。 。 。 . `subscribeEntity`, (中文(简体) ), `subscribeKind`,以及 `subscribe` 准确通知. `snapshotHash()` 产生犬科动物 `h1_` 用于跨地表差异检查的散列.
-   `ViewInstanceCache`数字 : `fresh | stale | loading | error` 键入条目 `viewId.paramsHash.authScopeHash`。条目记录的类版本 其依赖性清单为双倍; `invalidate(classes, classVersions?)` 标记 只有依赖的条目 stale, 并且只有当一个类实际升级.

## 示例

```ts
import { EntityStore, ViewInstanceCache } from "@asterql/store";

const store = new EntityStore();
store.cursors.beginScope("chat:abc", 0);

const { result, changedKeys, invalidated } = store.ingest({
  eventId: "ev1_…",
  kind: "patch",
  scope: "chat:abc",
  seq: 1,
  entities: [
    {
      key: "message:m1",
      patches: [{ op: "appendText", path: "/text", delta: "Hello" }],
    },
  ],
});

if (result.kind === "gap") {
  // fetch /scopes/chat:abc/events?afterSeq=result.lastSeq, then re-ingest;
  // escalate to a snapshot replace when the retention window is exceeded.
}

const views = new ViewInstanceCache();
views.invalidate(invalidated, { "entityKind:message": Date.now() });
```

获取,运输,和乐观的突变 故意超出范围: 这个包是这些层共享的存储和固态政策.

## 结构共享

`EntityStore.ingest` 保存现有记录(相同的引用,相同) 如果更改产生一个等值记录,并报告否 变了的密钥——一个平等的快照使下游没有什么.

## 常见问题

### @asterql/store 是什么？

规范化的实体存储,范围光标,以及用于AsterQL状态同步的查看-监视缓存\.

### 如何安装 @asterql/store？

在项目目录运行 npm install @asterql/store，或使用 pnpm add / yarn add / bun add。

### @asterql/store 支持 TypeScript 吗？

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

### @asterql/store 支持 ESM 还是 CommonJS？

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

### @asterql/store 需要什么版本的 Node\.js？

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

### @asterql/store 可以商用吗？

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

### @asterql/store 的下载量有多少？

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

### @asterql/store 还在维护吗？

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