# @eventcatalog/sdk 中文文档

规范地址：https://npmcn.com/package/%40eventcatalog/sdk/

版本：2\.32\.1
npm 元数据更新时间：2026-11-10T13:21:57.631Z
中文译文更新时间：2026-11-14T01:05:16.651Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：2 MB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：8 个
- 首次发布：2024-07-18T08:49:35.587Z
- 最新版本发布：2026-11-10T13:21:56.126Z
- 近 30 天下载量：123526（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：165（近 12 个月 69 个）

## 中文简介

与事件Catalog 集成的 SDK

## 安装

```sh
npm install @eventcatalog/sdk
```

也可以使用：`pnpm add @eventcatalog/sdk`、`yarn add @eventcatalog/sdk`、`bun add @eventcatalog/sdk`

## README

## @ eventcatalog/ sdk

SDK 可以在 JavaScript/ TypeScript 程序上与您的事件Catalog 交互 .

### 动机

EventCatalog的愿景是与世界上任何经纪人或技术相融合. 由于它由Markdown提供动力,并且内容是在建设时建造的,因此可以使用SDK 创造这些资源。 例如,您可以与您的系统集成,使用此 SDK 为 EventCatalog 创建域、服务和消息 .

SDK支持用于EventCatalog中域,服务和消息的标准CRUD操作.

SDK 用于创建您自己的 EventCatalog 插件和集成 .

**特征**

-   在 EventCatalog 中创建、读取和删除资源
-   使用 EventCatalog 版本任何资源 `version` (原始内容存档于2017-09-21). SDK Api.
-   在 EventCatalog 中向资源添加文件或计划
-   还有...

### 安装

```sh
npm i @eventcatalog/sdk
```

### 示例用途

```typescript
import utils from '@eventcatalog/sdk';

const { getEvent, versionEvent, getService } = utils(PATH_TO_CATALOG);

// Gets event by id
const event = await getEvent('InventoryEvent');

// Gets event by id and version
const event2 = await getEvent('InventoryEvent', '1.0.0');

// Version the event InventoryEvent (e.g goes to /versioned/{version}/InventoryEvent)
await versionEvent('InventoryEvent');

// Returns the service /services/PaymentService
const service = await getService('PaymentService');
```

### 国 际

正在寻找命令行的使用吗 ? 见 [@eventcatalog/cli (英语)](https://npmcn.com/package/%40eventcatalog/cli)。 。 。 .

见 [SDK 文档](https://www.eventcatalog.dev/docs/sdk) 更多信息和实例.

# 企业支助

有兴趣和我们合作吗? 我们的提议包括专门支助、优先援助、特色发展、定制一体化等等.

找到更多关于我们的细节 [服务页面](https://eventcatalog.dev/services)。 。 。 .

## 常见问题

### @eventcatalog/sdk 是什么？

与事件Catalog 集成的 SDK

### 如何安装 @eventcatalog/sdk？

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

### @eventcatalog/sdk 支持 TypeScript 吗？

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

### @eventcatalog/sdk 支持 ESM 还是 CommonJS？

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

### @eventcatalog/sdk 可以商用吗？

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

### @eventcatalog/sdk 的下载量有多少？

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

### @eventcatalog/sdk 还在维护吗？

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