# @colyseus/ws-transport 中文文档

规范地址：https://npmcn.com/package/%40colyseus/ws-transport/

版本：0\.18\.4
npm 元数据更新时间：2026-10-22T14:38:04.140Z
中文译文更新时间：2026-11-10T11:25:41.722Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40colyseus/ws-transport
原文对照：https://npmcn.com/package/%40colyseus/ws-transport/?lang=original
项目主页：https://colyseus.io/
源码仓库：https://github.com/colyseus/colyseus

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

- 包体积（解压后）：88.9 kB，21 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 22\.x
- 运行依赖：2 个
- peer 依赖：express ^4\.16\.0 \|\| ^5\.0\.0，@colyseus/core ^0\.18\.5
- 首次发布：2021-07-02T17:33:39.698Z
- 最新版本发布：2026-09-25T21:57:07.363Z
- 近 30 天下载量：562132（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：56（近 12 个月 18 个）

## 中文简介



## 安装

```sh
npm install @colyseus/ws-transport
```

也可以使用：`pnpm add @colyseus/ws-transport`、`yarn add @colyseus/ws-transport`、`bun add @colyseus/ws-transport`

## README

# @colyseus/ws- transfer

```typescript
import { Server } from "@colyseus/core";
import { WebSocketTransport } from "@colyseus/ws-transport";

const gameServer = new Server({
  transport: new WebSocketTransport(),
  // ...
})
```

重新使用已有的 http 服务器和/或快递 :

```typescript
import http from "http";
import express from "express";
import { Server } from "@colyseus/core";
import { WebSocketTransport } from "@colyseus/ws-transport";

const app = express();
const server = http.createServer(app);

const gameServer = new Server({
  transport: new WebSocketTransport({ server }),
  // ...
})
```

## 常见问题

### 如何安装 @colyseus/ws-transport？

在项目目录运行 npm install @colyseus/ws-transport，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：express（^4\.16\.0 \|\| ^5\.0\.0）、@colyseus/core（^0\.18\.5）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @colyseus/ws-transport 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @colyseus/ws-transport 支持 ESM 还是 CommonJS？

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

### @colyseus/ws-transport 需要什么版本的 Node\.js？

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

### @colyseus/ws-transport 可以商用吗？

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

### @colyseus/ws-transport 的下载量有多少？

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

### @colyseus/ws-transport 还在维护吗？

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