@adonisjs/websocket-packet

中文文档
1.0.6发布于 2018/03/14MITESM + CJS零依赖近 30 天下载 7361

校验、 创建 adonis 网络保护包

中文使用文档
文档目录30 节
  1. 安装
  2. 节点/网络包装
  3. 光盘N
  4. 常数
  5. 职能
  6. 代码 : Object
  7. 单位
  8. 是JoinPacket(套件) QQ Boolean
  9. 是 LeavePacket( 套件) QQ Boolean
  10. 是 OpenPacket( 软件包) {} Boolean
  11. 是JoinAckPacket(套件) {} Boolean
  12. 是 JOIN ErrorPacket( 包) QQ Boolean
  13. 是Leave AckPacket(套件) QQ Boolean
  14. 是 Leave ErrorPacket( 包) QQ Boolean
  15. 是 EventPacket( 软件包) {} Boolean
  16. 平板电脑( 软件包) QQ Boolean
  17. 是 PongPacket( 套件) QQ Boolean
  18. has Topic( 套件) QQ Boolean
  19. 是 ValidJoinPacket () Boolean
  20. 是 ValidLeavePacket () QQ Boolean
  21. 是 ValidEventPacket () @% Boolean
  22. 加入Packet(专题) QQ Object
  23. 叶包(专题) Object
  24. 加入 AckPacket(专题) {} Object
  25. 加入 ErrorPacket( 专题、 消息) {} Object
  26. aCKPacket(专题) Object
  27. 离开 ErrorPacket( 专题, 信件) QQ Object
  28. 事件包( 专题、 事件、 数据) QQ Object
  29. pingPacket () Object
  30. 海绵袋( ) QQ Object

网页包

这个库用来创建/验证AdonisJs使用的websocket包.

如果您正在编写 Javascript 客户端, 这是您必须使用的库 。 在为其他平台编写客户端库时,只需遵循文档和代码来创建您的执行.

Travis

安装

节点/网络包装

npm i --save @adonisjs/websocket-packet
const wsp = require('@adonisjs/websocket-packet')

// or
import wsp from '@adonisjs/websocket-packet'

console.log(wsp.codes)
wsp.isJoinPacket(packet)

光盘N

<script src="https://unpkg.com/@adonisjs/websocket-packet"></script>
<script type="text/javascript">
  console.log(adonis.wsp.codes)
  console.log(adonis.wsp.isJoinPacket(packet))
</script>

常数

代码 数字 : Object

包裹密码. 实际的包会有数字

单位

要导出的数量

职能

是JoinPacket( 软件包) ⇒ Boolean

如果包代码是 JOIN 代码.

是LeavePacket( 软件包) ⇒ Boolean

如果包代码是 LEAVE 代码.

是 OpenPacket( 软件包) ⇒ Boolean

如果包代码是 OPEN 代码.

是JoinAckPacket(套件) ⇒ Boolean

如果包代码是 JOIN_ACK 代码.

是 JoinErrorPacket( 软件包) ⇒ Boolean

如果包代码是 JOIN_ERROR 代码.

是Leave AckPacket( 软件包) ⇒ Boolean

如果包代码是 LEAVE_ACK 代码.

是Leave ErrorPacket( 软件包) ⇒ Boolean

如果包代码是 LEAVE_ERROR 代码.

是 EventPacket( 软件包) ⇒ Boolean

如果包代码是 EVENT 代码.

是平板电脑( 软件包) ⇒ Boolean

如果包代码是 PING 代码.

是 PongPacket( 软件包) ⇒ Boolean

如果包代码是 PONG 代码.

has Topic( 软件包) ⇒ Boolean

查找包是否有话题 .

是 ValidJoinPacket () (中文(简体) ) ⇒ Boolean

确定数据包是一个有效的连接数据包 。 打电话 isJoinPacket 在使用这种方法之前.

是 ValidLeavePacket () 密码 ⇒ Boolean

确定包是一个有效的休假包。 打电话 isLeavePacket 在使用这种方法之前.

是 ValidEvenet 软件包( ) ⇒ Boolean

确定包是一个有效的事件包 。 打电话 isEventPacket 在使用这种方法之前.

加入Packet(专题) ⇒ Object

制作组合

叶包(专题) ⇒ Object

做一个休假包

加入 AckPacket(专题) ⇒ Object

加入确认包

加入 ErrorPacket( 专题, 消息) ⇒ Object

合并错误包

aCKPacket(专题) ⇒ Object

制作休假包

离开 ErrorPacket( 专题, 信件) ⇒ Object

制作出离开错误包

事件包(专题、事件、数据) ⇒ Object

制作事件包

pingPacket () () ⇒ Object

制作 ping 包

海绵袋( ) ⇒ Object

做海绵包

代码 : Object

包裹密码. 实际的包会有数字

仁爱: 全球常数
示例

{
 OPEN: 0,
 JOIN: 1,
 LEAVE: 2,
 JOIN_ACK: 3,
 JOIN_ERROR: 4,
 LEAVE_ACK: 5,
 LEAVE_ERROR: 6,
 EVENT: 7,
 PING: 8,
 PONG: 9
}

单位

要导出的数量

仁爱: 全球常数

是JoinPacket(套件) QQ Boolean

如果包代码是 JOIN 代码.

仁爱:全球职能

参数类型
数据包Object

是 LeavePacket( 套件) QQ Boolean

如果包代码是 LEAVE 代码.

仁爱:全球职能

参数类型
数据包Object

是 OpenPacket( 软件包) {} Boolean

如果包代码是 OPEN 代码.

仁爱:全球职能

参数类型
数据包Object

是JoinAckPacket(套件) {} Boolean

如果包代码是 JOIN_ACK 代码.

仁爱:全球职能

参数类型
数据包Object

是 JOIN ErrorPacket( 包) QQ Boolean

如果包代码是 JOIN_ERROR 代码.

仁爱:全球职能

参数类型
数据包Object

是Leave AckPacket(套件) QQ Boolean

如果包代码是 LEAVE_ACK 代码.

仁爱:全球职能

参数类型
数据包Object

是 Leave ErrorPacket( 包) QQ Boolean

如果包代码是 LEAVE_ERROR 代码.

仁爱:全球职能

参数类型
数据包Object

是 EventPacket( 软件包) {} Boolean

如果包代码是 EVENT 代码.

仁爱:全球职能

参数类型
数据包Object

平板电脑( 软件包) QQ Boolean

如果包代码是 PING 代码.

仁爱:全球职能

参数类型
数据包Object

是 PongPacket( 套件) QQ Boolean

如果包代码是 PONG 代码.

仁爱:全球职能

参数类型
数据包Object

has Topic( 套件) QQ Boolean

查找包是否有话题 .

仁爱:全球职能

参数类型
数据包Object

是 ValidJoinPacket () Boolean

确定数据包是一个有效的连接数据包 。 打电话 isJoinPacket 在使用这种方法之前.

仁爱:全球职能

是 ValidLeavePacket () QQ Boolean

确定包是一个有效的休假包。 打电话 isLeavePacket 在使用这种方法之前.

仁爱:全球职能

是 ValidEventPacket () @% Boolean

确定包是一个有效的事件包 。 打电话 isEventPacket 在使用这种方法之前.

仁爱:全球职能

加入Packet(专题) QQ Object

制作组合

仁爱:全球职能
掷出数字 :

  • Error 如果主题没有定义或不是字符串
参数类型
专题String

叶包(专题) Object

做一个休假包

仁爱:全球职能
掷出数字 :

  • Error 如果主题没有定义或不是字符串
参数类型
专题String

加入 AckPacket(专题) {} Object

加入确认包

仁爱:全球职能
掷出数字 :

  • Error 如果主题没有定义或不是字符串
参数类型
专题String

加入 ErrorPacket( 专题、 消息) {} Object

合并错误包

仁爱:全球职能
掷出数字 :

  • Error 如果主题没有定义或不是字符串
  • Error 如果信件没有定义或字符串
参数类型
专题String
消息String

aCKPacket(专题) Object

制作休假包

仁爱:全球职能
掷出数字 :

  • Error 如果主题没有定义或不是字符串
参数类型
专题String

离开 ErrorPacket( 专题, 信件) QQ Object

制作出离开错误包

仁爱:全球职能
掷出数字 :

  • Error 如果主题没有定义或不是字符串
  • Error 如果信件没有定义或字符串
参数类型
专题String
消息String

事件包( 专题、 事件、 数据) QQ Object

制作事件包

仁爱:全球职能
掷出数字 :

  • Error 如果主题没有定义或不是字符串
  • Error 如果事件没有定义
  • Error 未定义数据
参数类型
专题String
事件String
数据Mixed

pingPacket () Object

制作 ping 包

仁爱:全球职能

海绵袋( ) QQ Object

做海绵包

仁爱:全球职能

版本与发布记录

@adonisjs/websocket-packet 共发布 7 个版本,首次发布于 2018/02/20;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.6latest2018/03/148 年前
1.0.52018/03/118 年前
1.0.42018/03/068 年前
1.0.32018/02/278 年前
1.0.22018/02/258 年前
1.0.12018/02/208 年前

关于 @adonisjs/websocket-packet 的常见问题

@adonisjs/websocket-packet 是什么?

校验、 创建 adonis 网络保护包

如何安装 @adonisjs/websocket-packet?

在项目目录运行 npm install @adonisjs/websocket-packet,或使用 pnpm add / yarn add / bun add。

@adonisjs/websocket-packet 支持 TypeScript 吗?

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

@adonisjs/websocket-packet 支持 ESM 还是 CommonJS?

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

@adonisjs/websocket-packet 可以商用吗?

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

@adonisjs/websocket-packet 的下载量有多少?

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

@adonisjs/websocket-packet 还在维护吗?

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