# @epic-web/test-server 中文文档

规范地址：https://npmcn.com/package/%40epic-web/test-server/

版本：0\.1\.6
npm 元数据更新时间：2025-06-01T20:11:39.219Z
中文译文更新时间：2026-11-13T19:35:20.464Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40epic-web/test-server
原文对照：https://npmcn.com/package/%40epic-web/test-server/?lang=original
项目主页：https://github.com/epicweb-dev/test-server#readme
源码仓库：https://github.com/epicweb-dev/test-server

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

- 包体积（解压后）：24.3 kB，12 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：6 个
- 首次发布：2024-08-23T13:09:15.280Z
- 最新版本发布：2025-06-01T20:11:39.014Z
- 近 30 天下载量：43746（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 0 个）

## 中文简介

用于创建 HTTP 和 WebSocket 服务器测试的工具

## 安装

```sh
npm install @epic-web/test-server
```

也可以使用：`pnpm add @epic-web/test-server`、`yarn add @epic-web/test-server`、`bun add @epic-web/test-server`

## README

# 测试服务器

用于创建HTTP和WebSocket服务器进行测试的功能.

## 特征

-   **压缩**. Spawn 服务器按需运行,同时将测试设置保持在最低限度.
-   **自动一次性**此工具与 [`using`](https://www.totaltypescript.com/typescript-5-2-new-keyword-using) 记住关键词 任何你产下的服务器都自动关闭 一旦没有使用它们.
-   **基于标准**。使用网络标准处理请求和答复。 此库使用 [浩诺](https://hono.dev/) 到产卵服务器.

## 安装

```sh
npm install @epic-web/test-server
```

## 使用量

### HTTP 服务器

```ts
import { createTestHttpServer } from '@epic-web/test-server/http'

it('fetches the list of numbers', async () => {
  // Create a disposable "server" instance.
  await using server = await createTestHttpServer({
    defineRoutes(router) {
      router.get('/numbers', () => {
        return Response.json([1, 2, 3])
      })
    }
  })

  // Construct URLs relatively to the test server.
  const response = await fetch(server.http.url('/numbers'))
  await expect(response.json()).resolves.toEqual([1, 2, 3])
})
```

### WebSocket 服务器

```ts
import { createTestHttpServer } from '@epic-web/test-server/http'
import { createWebSocketMiddleware } from '@epic-web/test-server/ws'

it('handles WebSocket communication', async () => {
  await using server = await createTestHttpServer()
  // Attach WebSockets as a middleware to an existing HTTP server.
  await using wss = createWebSocketMiddleware({ server })

  // Handle WebSocket connections.
  wss.ws.on('connect', (socket) => console.log('new connection!'))

  const client = new WebSocket(wss.ws.url())
})
```

## API 密码

### `createTestHttpServer([options])`

创建 HTTP 服务器实例 .

-   `options` (可选)
    -   `protocols`, (可选) `Array<'http' | 'https'>` (默认 : `['http']`),在产入测试服务器时使用的协议列表. 提供多个值将生成多个服务器,并有相应的控制通过 `server.http` 财务报告和审定财务报表 `server.https`。 。 。 .
    -   `defineRoutes`, (可选) `(router: Router) => void`,一个描述服务器路线的函数.
-   回返情况: [承诺 <`TestHttpServer`\> 翻译:](https://npmcn.com/package/%40epic-web/test-server/#readme-testhttpserver)

### `TestHttpServer`

#### `TestHttpServer.http.url([pathname])`

-   `pathname` (可选,默认: `/`, (中文(简体) ), `string`,用于对照服务器的 URL 解决的路径名.
-   回返情况: `URL`。 。 。 .

呼叫电话 `.url()` 没有参数的方法返回此服务器的 URL :

```ts
server.http.url() // URL<http://localhost:56783/>
```

提供 `pathname` 参数返回该路径的 URL :

```ts
server.http.url('/resource') // URL<http://localhost:56783/resource>
```

#### `TestHttpServer.close()`

关闭 HTTP 服务器, 中止任何待决请求 .

> \[大 这个 `createTestHttpServer()` 是一个 _一次性_ 函数。 这意味着JavaScript将自动处理服务器实例(即关闭它),因为没有其他信息可以引用 `server` 对象. _你不用手动关闭服务器_但你们 _能够_ 如果测试需要关闭服务器的话.

### `createWebSocketMiddleware(options)`

-   `options`
    -   `server`, (中文(简体) ), [`TestHttpServer`](https://npmcn.com/package/%40epic-web/test-server/#readme-testhttpserver),指的是现有的测试 HTTP 服务器对象.
-   回返情况: [测试网锁服务器](https://npmcn.com/package/%40epic-web/test-server/#readme-testwebsocketserver)

> 注:WebSocket中间软件将自动附着到所有产入的HTTP服务器上. 如果您同时使用多个服务器( 如 HTTP + HTTPS), 两者均 `wss.ws` 财务报告和审定财务报表 `wss.wss` API将分别提供给WebSockets.

### `TestWebSocketServer`

#### `TestWebSocketServer.on(type, listener)`

为指定事件添加一个听众.

```ts
wss.ws.on('connection', () => {})
wss.wss.on('connection', () => {})
```

#### `TestWebSocketServer.once(type, listener)`

为指定事件添加一次性的收听器.

#### `TestWebSocketServer.off(type, listener)`

从给定的事件中删除一个听众.

## 常见问题

### @epic-web/test-server 是什么？

用于创建 HTTP 和 WebSocket 服务器测试的工具

### 如何安装 @epic-web/test-server？

在项目目录运行 npm install @epic-web/test-server，或使用 pnpm add / yarn add / bun add。

### @epic-web/test-server 支持 TypeScript 吗？

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

### @epic-web/test-server 支持 ESM 还是 CommonJS？

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

### @epic-web/test-server 需要什么版本的 Node\.js？

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

### @epic-web/test-server 可以商用吗？

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

### @epic-web/test-server 的下载量有多少？

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

### @epic-web/test-server 还在维护吗？

最新版本 0\.1\.6 发布于 2025/06/02（1\.5 年前）；至今共发布 7 个版本，其中过去 12 个月发布了 0 个；首次发布于 2024/08/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。