# @acuris/eventstore-api 中文文档

规范地址：https://npmcn.com/package/%40acuris/eventstore-api/

版本：3\.0\.0
npm 元数据更新时间：2024-02-29T11:46:23.208Z
中文译文更新时间：2026-11-06T01:50:01.527Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40acuris/eventstore-api
原文对照：https://npmcn.com/package/%40acuris/eventstore-api/?lang=original
源码仓库：https://github.com/ION-Analytics/acuris-eventstore-api

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

- 包体积（解压后）：34.6 kB，31 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：rxjs \>= 7\.1\.0
- 首次发布：2020-08-10T16:37:39.343Z
- 最新版本发布：2024-02-29T11:46:22.725Z
- 近 30 天下载量：6968（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：31（近 12 个月 0 个）

## 中文简介

访问事件存储的 API

## 安装

```sh
npm install @acuris/eventstore-api
```

也可以使用：`pnpm add @acuris/eventstore-api`、`yarn add @acuris/eventstore-api`、`bun add @acuris/eventstore-api`

## README

# 事件tore API

依据

-   [https://github.com/tim-group/tg-eventstore 页面存档备份,存于互联网档案馆 互联网档案馆](https://github.com/tim-group/tg-eventstore) (贾瓦)
-   [https://github.com/araqnid/eventstore 页面存档备份,存于互联网档案馆](https://github.com/araqnid/eventstore) (科特林语)

## 使用量

读取流 :

```typescript
async function listTransactionHistory(transactionId: string, eventSource: EventSource): Promise<{timestamp: Date, data: Transaction}> {
  return lastValueFrom(
      eventSource.streamReader.readStreamForwards({category: "transaction", id: transactionId})
        .pipe(toArray(), map(re => ({timestamp: re.event.timestamp, data: re.event.data as Transaction})))
  )
}
```

读取整个商店 :

```typescript
return new Promise(((resolve, reject) => {
    let lastPosition = position
    eventSource.storeReader.readAll(position).subscribe(
      re => {
        ingestTransaction(re.event.data as Transaction)
        lastPosition = re.position
      },
      err => reject("Failed to read all transactions since " + lastPosition + ": " + err),
      () => resolve(lastPosition)
    )
}))
```

## 以 Pretier 格式化代码

建议您使用 `prettier` 用于格式化,以便我们有一个一致的代码样式.

如果您正在使用IntelliJ,请安装 Pretier 插件 。 您可以在正常运行格式时配置它以运行( 见 `Languages & Frameworks > Javascript > Prettier` 并检查“ 运行“ 格式化代码” 动作”

## 常见问题

### @acuris/eventstore-api 是什么？

访问事件存储的 API

### 如何安装 @acuris/eventstore-api？

在项目目录运行 npm install @acuris/eventstore-api，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：rxjs（\>= 7\.1\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @acuris/eventstore-api 支持 TypeScript 吗？

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

### @acuris/eventstore-api 支持 ESM 还是 CommonJS？

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

### @acuris/eventstore-api 可以商用吗？

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

### @acuris/eventstore-api 的下载量有多少？

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

### @acuris/eventstore-api 还在维护吗？

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