# @condor-labs/ec-events-gateway 中文文档

规范地址：https://npmcn.com/package/%40condor-labs/ec-events-gateway/

版本：2\.0\.0
npm 元数据更新时间：2023-07-07T15:55:53.853Z
中文译文更新时间：2026-11-10T16:09:49.388Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40condor-labs/ec-events-gateway
原文对照：https://npmcn.com/package/%40condor-labs/ec-events-gateway/?lang=original
项目主页：https://github.com/cebroker/ec-applications/tree/master/ec-events-gateway-client#readme
源码仓库：https://github.com/cebroker/ec-applications

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

- 包体积（解压后）：34.3 kB，15 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：5 个
- 首次发布：2019-06-25T19:58:51.400Z
- 最新版本发布：2023-07-07T15:55:53.536Z
- 近 30 天下载量：3004（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

客户端将事件发送到事件网关 API

## 安装

```sh
npm install @condor-labs/ec-events-gateway
```

也可以使用：`pnpm add @condor-labs/ec-events-gateway`、`yarn add @condor-labs/ec-events-gateway`、`bun add @condor-labs/ec-events-gateway`

## README

# 事件网关客户端

通过事件网关服务发送消息的库.

## 怎样用

要使用此库, 您只需遵循以下步骤 安装 npm 的库

`npm install @condor-labs/ec-events-gateway`

导入库

`const { events } = require('@condor-labs/ec-events-gateway');`

使用ES6:

`import { events } from '@condor-labs/ec-events-gateway':`

### 环境变量

在您中定义变量 **.env 数据** 带有以下名称的事件网关 api URL 的文件 :

`EVENTS_GATEWAY_URL`

这就是你需要开始发送数据 到事件网关api.

作为替代,您可以通过一个事件网关 api url 作为参数 :

`events.save({payload, type, topic, schema, headers, url: 'http://localhost'});`

### 所需数据

要通过事件网关客户端发送事件, 您必须发送一些所需的字段 :

-   类型:字符串,
-   主题:字符串,
-   有效载荷:物体

### 客户端Schema

> @hapi/joi 不再有效使用 [乔](https://www.npmjs.com/package/joi) 换成

您可以定义一个有效的Joi(Joi QQ17.9.2) schema来验证您发送到事件网关服务的事件数据 .

**示例**

```
const schema = {
    firstName: Joi.number().required()
};
```

您可以在Joi API 文档中看到更多实例 [网站](https://github.com/hapijs/joi/blob/v17.9.2/API.md)。 。 。 .

然后把这个计划通过 **保存** 函数作为参数.

`events.save({payload, type, topic, schema, headers, url: 'http://localhost'});`

### 标题 :

您应该定义标题, 以将密钥传递给 Amazon 服务 :

```
headers: {
    'x-api-key': 'value'
}
```

### 最大有效载荷大小

请确保有效载荷数据少于 **250kb (中文(简体) )**

## 常见问题

### @condor-labs/ec-events-gateway 是什么？

客户端将事件发送到事件网关 API

### 如何安装 @condor-labs/ec-events-gateway？

在项目目录运行 npm install @condor-labs/ec-events-gateway，或使用 pnpm add / yarn add / bun add。

### @condor-labs/ec-events-gateway 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/condor-labs\_\_ec-events-gateway 是否存在。

### @condor-labs/ec-events-gateway 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @condor-labs/ec-events-gateway 可以商用吗？

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

### @condor-labs/ec-events-gateway 的下载量有多少？

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

### @condor-labs/ec-events-gateway 还在维护吗？

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