@aws-lite/apigatewaymanagementapi

中文文档
0.0.10发布于 2024/08/02Apache-2.0ES Module零依赖近 30 天下载 4.3万

Official aws-lite plugin for API Gateway WebSocket Management API

原始使用文档
文档目录7 节
  1. Install
  2. Reference
  3. Methods
  4. PostToConnection
  5. DeleteConnection
  6. GetConnection
  7. Learn more

@aws-lite/apigatewaymanagementapi

Official aws-lite plugin for API Gateway WebSocket Management API

Maintained by: @architect

Install

npm i @aws-lite/apigatewaymanagementapi

Optionally install types:

npm i -D @aws-lite/apigatewaymanagementapi-types

Reference

Reference documentation with examples at aws-lite.org

Methods

PostToConnection

Canonical AWS API doc

Properties:

  • ConnectionId (string) [required]
    • WebSocket connection ID
  • ApiUrl (string)
    • Full API Gateway WebSocket URL, including stage; if using this, do not use ApiId and Stage; example: wss://abc123.execute-api.us-west-1.amazonaws.com/$default
  • ApiId (string)
    • API Gateway ID
  • Stage (string)
    • API Gateway stage; example: $default
  • Data (string, object)
    • Data to send to WebSocket client

DeleteConnection

Canonical AWS API doc

Properties:

  • ConnectionId (string) [required]
    • WebSocket connection ID
  • ApiUrl (string)
    • Full API Gateway WebSocket URL, including stage; if using this, do not use ApiId and Stage; example: wss://abc123.execute-api.us-west-1.amazonaws.com/$default
  • ApiId (string)
    • API Gateway ID
  • Stage (string)
    • API Gateway stage; example: $default

GetConnection

Canonical AWS API doc

Properties:

  • ConnectionId (string) [required]
    • WebSocket connection ID
  • ApiUrl (string)
    • Full API Gateway WebSocket URL, including stage; if using this, do not use ApiId and Stage; example: wss://abc123.execute-api.us-west-1.amazonaws.com/$default
  • ApiId (string)
    • API Gateway ID
  • Stage (string)
    • API Gateway stage; example: $default

Learn more

版本与发布记录

@aws-lite/apigatewaymanagementapi 共发布 11 个版本,首次发布于 2023/10/18;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.0.10latest2024/08/022 年前
0.0.92024/08/012 年前
0.0.82024/02/072 年前
0.0.72024/01/302 年前
0.0.62023/12/262 年前
0.0.52023/12/132 年前

关于 @aws-lite/apigatewaymanagementapi 的常见问题

@aws-lite/apigatewaymanagementapi 是什么?

Official aws-lite plugin for API Gateway WebSocket Management API

如何安装 @aws-lite/apigatewaymanagementapi?

在项目目录运行 npm install @aws-lite/apigatewaymanagementapi,或使用 pnpm add / yarn add / bun add。

@aws-lite/apigatewaymanagementapi 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/aws-lite__apigatewaymanagementapi 是否存在。

@aws-lite/apigatewaymanagementapi 支持 ESM 还是 CommonJS?

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

@aws-lite/apigatewaymanagementapi 需要什么版本的 Node.js?

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

@aws-lite/apigatewaymanagementapi 可以商用吗?

@aws-lite/apigatewaymanagementapi 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@aws-lite/apigatewaymanagementapi 的下载量有多少?

根据 npm 官方下载统计,@aws-lite/apigatewaymanagementapi 在 2026/10/08 – 2026/11/06 这 30 天内被下载 43,349 次,日均约 1,445 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@aws-lite/apigatewaymanagementapi 还在维护吗?

最新版本 0.0.10 发布于 2024/08/02(2 年前);至今共发布 11 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/10/18。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。