@condor-labs/ec-events-gateway

中文文档
2.0.0发布于 2023/07/07ISCCommonJS近 30 天下载 3004

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

中文使用文档
文档目录6 节
  1. 怎样用
  2. 环境变量
  3. 所需数据
  4. 客户端Schema
  5. 标题 :
  6. 最大有效载荷大小

事件网关客户端

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

怎样用

要使用此库, 您只需遵循以下步骤 安装 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 不再有效使用 乔 换成

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

示例

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

您可以在Joi API 文档中看到更多实例 网站。 。 。 .

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

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

标题 :

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

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

最大有效载荷大小

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

版本与发布记录

@condor-labs/ec-events-gateway 共发布 4 个版本,首次发布于 2019/06/26;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.0.0latest2023/07/073 年前
1.2.02019/07/047 年前
1.1.02019/07/037 年前
1.0.02019/06/267 年前

关于 @condor-labs/ec-events-gateway 的常见问题

@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 和提交记录判断。