# @aptre/it-ws 中文文档

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

版本：1\.1\.2
npm 元数据更新时间：2025-07-06T03:27:20.560Z
中文译文更新时间：2026-11-06T13:04:10.500Z
软件包许可：Apache-2\.0 OR MIT

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

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

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

- 包体积（解压后）：66.2 kB，60 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=16\.0\.0
- 运行依赖：4 个
- 首次发布：2023-12-19T22:26:37.589Z
- 最新版本发布：2025-07-06T03:27:20.380Z
- 近 30 天下载量：23406（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

用于 Websocket 客户端连接的简单模拟可操作性

## 安装

```sh
npm install @aptre/it-ws
```

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

## README

# 这..

> 用于 Websocket 客户端连接的简单模拟可操作性

## 通知:叉子

**这是它的维护叉。 与上游一揽子方案相比,它最大限度地减少了依赖性.**

此软件包发布于 `@aptre/it-ws`。 。 。 .

## 目录

-   [安装](https://npmcn.com/package/%40aptre/it-ws/#readme-install)
    -   [浏览器 `<script>` 标签](https://npmcn.com/package/%40aptre/it-ws/#readme-browser-script-tag)
-   [使用量](https://npmcn.com/package/%40aptre/it-ws/#readme-usage)
    -   [示例 - 客户端](https://npmcn.com/package/%40aptre/it-ws/#readme-example---client)
    -   [示例 - 服务器](https://npmcn.com/package/%40aptre/it-ws/#readme-example---server)
-   [API 密码](https://npmcn.com/package/%40aptre/it-ws/#readme-api)
    -   [`import { connect } from 'it-ws/client'`](https://npmcn.com/package/%40aptre/it-ws/#readme-import--connect--from-it-wsclient)
    -   [`import { createServer } from 'it-ws/server'`](https://npmcn.com/package/%40aptre/it-ws/#readme-import--createserver--from-it-wsserver)
        -   [示例](https://npmcn.com/package/%40aptre/it-ws/#readme-example)
-   [使用 http 服务器](https://npmcn.com/package/%40aptre/it-ws/#readme-use-with-an-http-server)
    -   [核心、 websocket 包接功能](https://npmcn.com/package/%40aptre/it-ws/#readme-core-websocket-wrapping-functions)
    -   [`import duplex from 'it-ws/duplex'`](https://npmcn.com/package/%40aptre/it-ws/#readme-import-duplex-from-it-wsduplex)
    -   [`import sink from 'it-ws/sink'`](https://npmcn.com/package/%40aptre/it-ws/#readme-import-sink-from-it-wssink)
    -   [`import source from 'it-ws/source'`](https://npmcn.com/package/%40aptre/it-ws/#readme-import-source-from-it-wssource)
-   [许可证](https://npmcn.com/package/%40aptre/it-ws/#readme-license)
-   [捐款](https://npmcn.com/package/%40aptre/it-ws/#readme-contribution)

## 安装

```console
$ npm i @aptre/it-ws
```

## 使用量

### 示例 - 客户端

```js
import { connect } from '@aptre/it-ws/client'
import { pipe } from 'it-pipe'

const stream = connect(WS_URL)

await stream.connected() // Wait for websocket to be connected (optional)

pipe(source, stream, sink)
```

### 示例 - 服务器

```js
import { createServer } from '@aptre/it-ws/server'
import { pipe } from 'it-pipe'

const server = createServer(stream => {
  //pipe the stream somewhere.
  //eg, echo server
  pipe(stream, stream)
})

await server.listen(PORT)
```

## API 密码

### `import { connect } from '@aptre/it-ws/client'`

`connect(url, { binary: boolean })`

创建 Websocket 客户端连接 。 设定 `binary: true` 以获取阵列缓冲(在浏览器上)。 在节点上默认为真,但在浏览器上默认为字符串. 如果您的应用程序假定为二进制, 可能会有问题 .

在 WebSocket 实例中添加选项, 如 [网格/ws/blob/master/doc/ws.md#新网格地址-protocols-选项](https://github.com/websockets/ws/blob/master/doc/ws.md#new-websocketaddress-protocols-options),可以提供对象 `websocket` 属性输入连接选项.

```js
const stream = connect(url)
// stream is duplex and is both a `source` and `sink`.
// See this for more information:
// https://gist.github.com/alanshaw/591dc7dd54e4f99338a347ef568d6ee9#duplex-it
```

### `import { createServer } from '@aptre/it-ws/server'`

创建可同步的websocket服务器 .

`createServer(options?, onConnection)`

`options` 使用与 [ws 模块](https://github.com/websockets/ws/blob/master/doc/ws.md#new-wsserveroptions-callback)

`onConnection(stream)` 每次收到连接时都会被调用.

#### 示例

您可能想要使用的双倍服务是 [粘合剂](https://github.com/dominictarr/muxrpc)

```js
import { createServer } from '@aptre/it-ws/server'
import { connect } from '@aptre/it-ws/client'
import { pipe } from 'it-pipe'

createServer({
  onConnection: (stream) => {
    // pipe duplex style to your service
    pipe(stream, service.createStream(), stream)
  }
})
.listen(9999)

const stream = client.createStream()

await pipe(
  stream,
  connect('ws://localhost:9999'),
  stream
)
```

如果连接失败, 溪流会抛出

```js
try {
  await pipe(
    stream,
    connect('ws://localhost:9999'),
    stream
  )
} catch (err) {
  // handle err
}
```

在 TLS 上运行服务器 :

```js
createServer({
  key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),
  cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem')
  // other options
})
.listen(9999)
```

要在服务器上添加客户端认证, 您可以设置 `verifyClient`。 。 。 . [这里的文档](https://github.com/websockets/ws/blob/master/doc/ws.md#optionsverifyclient)。 。 。 .

```js
function verifyClient (info) {
  return info.secure == true
}
createServer({
  verifyClient: verifyClient
  // other options
})
```

## 使用 http 服务器

如果您有 http 服务器, 您也需要服务 ,并想要使用单个端口,使用 `server` 选项.

```js
import http from 'http'

const server = http.createServer(function(req, res){...}).listen(....)

createServer({
  server: server
  // other options
})
```

### 核心、 websocket 包接功能

这些模块在内部被使用,用来包裹一个websocket. 你可能不需要碰这些, 但不管怎样,它们都是有记录的.

### `import duplex from '@aptre/it-ws/duplex'`

将一网囊变成双相流. 如果提供, `opts` 转至 `sink(socket, opts)`。 。 。 .

WebSockets 不支持半开模式. [参见净模块中允许的Half Open选项](http://nodejs.org/api/net.html#net_net_createserver_options_connectionlistener)

如果您有协议假设有半个打开连接, 但正在使用 网络协议,比如不支持的 Websockets,我建议 使用 [再见](https://github.com/alanshaw/it-goodbye) 还有你的 协议.

双层流还将包含来自 成为网页的 http 请求。 他们是 `method`, (中文(简体) ), `url`, (中文(简体) ), `headers` 财务报告和审定财务报表 `upgrade`。 。 。 .

还暴露在: `import { duplex } from '@aptre/it-ws'`

### `import sink from '@aptre/it-ws/sink'`

创建一个 `Sink` 将数据写入 `socket`。 。 。 . `opts` 也许 `{closeOnEnd: true, onClose: onClose}`。 。 。 . `onClose` 当水槽结束时,会叫它。 若为 `closeOnEnd=false` 流不会关闭, 它只会停止排放数据. (默认) `closeOnEnd` 事实)

若为 `opts` 是一个函数,那么 `onClose = opts; opts.closeOnEnd = true`。 。 。 .

```js
import sink from '@aptre/it-ws/sink'
import { pipe } from 'it-pipe'
import each from 'it-foreach'
import delay from 'delay'

// connect to the echo endpoint for test/server.js
var socket = new WebSocket('wss://echo.websocket.org')

// write values to the socket
pipe(
  async function * () {
    while (true) {
      yield 'hello @ ' + Date.now()
    }
  }(),
  // throttle so it doesn't go nuts
  (source) => each(source, () => delay(100))
  sink(socket)
);

socket.addEventListener('message', function(evt) {
  console.log('received: ' + evt.data);
});
```

还暴露于 `import { sink } from '@aptre/it-ws'`

### `import source from '@aptre/it-ws/source'`

创建一个 `Source` 读取来自 `socket`。 。 。 .

```js
import { pipe } from 'it-pipe'
import source from '@aptre/it-ws/source'

pipe(
  // connect to the test/server.js endpoint
  source(new WebSocket('ws://localhost:3000/read')),
  async (source) => {
    for await (const buf of source) {
      console.info(buf)
    }
  }
);

```

还暴露于 `import { source } from '@aptre/it-ws'`

## 许可证

根据其中任何一项颁发的许可证

-   Apache 2.0, (英语:[自由主义](https://npmcn.com/package/%40aptre/it-ws/LICENSE-APACHE) 编号 : [http://www.apache.org/licenses/LICENSE-2.0 (中文(简体) )](http://www.apache.org/licenses/LICENSE-2.0)(中文(简体) )
-   麻省理工学院[利马](https://npmcn.com/package/%40aptre/it-ws/LICENSE-MIT) 编号 : [http://opensource.org/licenses/MIT 互联网档案馆的存檔,存档日期2013-12-02](http://opensource.org/licenses/MIT)(中文(简体) )

## 捐款

除非另有明确声明,Apache-2.0许可证中界定的、有意提交供列入作品的任何捐助,应具有上述双重许可证,不附加任何条件.

## 常见问题

### @aptre/it-ws 是什么？

用于 Websocket 客户端连接的简单模拟可操作性

### 如何安装 @aptre/it-ws？

在项目目录运行 npm install @aptre/it-ws，或使用 pnpm add / yarn add / bun add。

### @aptre/it-ws 支持 TypeScript 吗？

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

### @aptre/it-ws 支持 ESM 还是 CommonJS？

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

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

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

### @aptre/it-ws 可以商用吗？

@aptre/it-ws 使用 Apache-2\.0 OR MIT 许可。可在 Apache-2\.0、MIT 中任选其一遵守。选择 Apache-2\.0 时，宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @aptre/it-ws 的下载量有多少？

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

### @aptre/it-ws 还在维护吗？

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