# @adonisjs/websocket-packet 中文文档

规范地址：https://npmcn.com/package/%40adonisjs/websocket-packet/

版本：1\.0\.6
npm 元数据更新时间：2023-05-08T04:48:47.401Z
中文译文更新时间：2026-11-06T01:14:41.443Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：29.9 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2018-02-20T14:12:38.957Z
- 最新版本发布：2018-03-14T07:54:24.260Z
- 近 30 天下载量：7361（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 0 个）

## 中文简介

校验、 创建 adonis 网络保护包

## 安装

```sh
npm install @adonisjs/websocket-packet
```

也可以使用：`pnpm add @adonisjs/websocket-packet`、`yarn add @adonisjs/websocket-packet`、`bun add @adonisjs/websocket-packet`

## README

# 网页包

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

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

[![Travis](https://img.shields.io/travis/adonisjs/adonis-websocket-packet.svg?style=for-the-badge)](https://github.com/adonisjs/adonis-websocket-packet)

## 安装

## 节点/网络包装

```bash
npm i --save @adonisjs/websocket-packet
```

```js
const wsp = require('@adonisjs/websocket-packet')

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

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

## 光盘N

```html
<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>
```

## 常数

[代码](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-codes) 数字 : `Object`

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

[单位](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-fns)

要导出的数量

## 职能

[是JoinPacket( 软件包)](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-isJoinPacket) ⇒ `Boolean`

如果包代码是 `JOIN` 代码.

[是LeavePacket( 软件包)](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-isLeavePacket) ⇒ `Boolean`

如果包代码是 `LEAVE` 代码.

[是 OpenPacket( 软件包)](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-isOpenPacket) ⇒ `Boolean`

如果包代码是 `OPEN` 代码.

[是JoinAckPacket(套件)](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-isJoinAckPacket) ⇒ `Boolean`

如果包代码是 `JOIN_ACK` 代码.

[是 JoinErrorPacket( 软件包)](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-isJoinErrorPacket) ⇒ `Boolean`

如果包代码是 `JOIN_ERROR` 代码.

[是Leave AckPacket( 软件包)](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-isLeaveAckPacket) ⇒ `Boolean`

如果包代码是 `LEAVE_ACK` 代码.

[是Leave ErrorPacket( 软件包)](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-isLeaveErrorPacket) ⇒ `Boolean`

如果包代码是 `LEAVE_ERROR` 代码.

[是 EventPacket( 软件包)](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-isEventPacket) ⇒ `Boolean`

如果包代码是 `EVENT` 代码.

[是平板电脑( 软件包)](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-isPingPacket) ⇒ `Boolean`

如果包代码是 `PING` 代码.

[是 PongPacket( 软件包)](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-isPongPacket) ⇒ `Boolean`

如果包代码是 `PONG` 代码.

[has Topic( 软件包)](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-hasTopic) ⇒ `Boolean`

查找包是否有话题 .

[是 ValidJoinPacket () (中文(简体) )](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-isValidJoinPacket) ⇒ `Boolean`

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

[是 ValidLeavePacket () 密码](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-isValidLeavePacket) ⇒ `Boolean`

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

[是 ValidEvenet 软件包( )](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-isValidEventPacket) ⇒ `Boolean`

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

[加入Packet(专题)](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-joinPacket) ⇒ `Object`

制作组合

[叶包(专题)](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-leavePacket) ⇒ `Object`

做一个休假包

[加入 AckPacket(专题)](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-joinAckPacket) ⇒ `Object`

加入确认包

[加入 ErrorPacket( 专题, 消息)](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-joinErrorPacket) ⇒ `Object`

合并错误包

[aCKPacket(专题)](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-leaveAckPacket) ⇒ `Object`

制作休假包

[离开 ErrorPacket( 专题, 信件)](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-leaveErrorPacket) ⇒ `Object`

制作出离开错误包

[事件包(专题、事件、数据)](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-eventPacket) ⇒ `Object`

制作事件包

[pingPacket () ()](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-pingPacket) ⇒ `Object`

制作 ping 包

[海绵袋( )](https://npmcn.com/package/%40adonisjs/websocket-packet/#readme-pongPacket) ⇒ `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 是什么？

校验、 创建 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 和提交记录判断。