# @aptre/yamux 中文文档

规范地址：https://npmcn.com/package/%40aptre/yamux/

版本：1\.0\.3
npm 元数据更新时间：2026-04-22T08:39:06.758Z
中文译文更新时间：2026-11-06T13:04:13.664Z
软件包许可：Apache-2\.0 OR MIT

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

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

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

- 包体积（解压后）：340 kB，54 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：8 个
- 首次发布：2026-04-22T08:25:57.593Z
- 最新版本发布：2026-04-22T08:39:06.492Z
- 近 30 天下载量：23265（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

Libp2p 的 Yamux 流多路xer

## 安装

```sh
npm install @aptre/yamux
```

也可以使用：`pnpm add @aptre/yamux`、`yarn add @aptre/yamux`、`bun add @aptre/yamux`

## README

# @ aptre/ yamux

> JavaScript 的 Yamux 流多路xer

# 关于

此模块是 JavaScript 执行 [哈希公司的亚穆克](https://github.com/hashicorp/yamux/blob/master/spec.md) 用于尽可能少的依赖.

这是叉子 [链安全网的js-libp2p-yamux](https://github.com/ChainSafe/js-libp2p-yamux) 并删除了用于独立应用程序的 libp2p 依赖.

## 示例 - 使用低级API

```js
import { yamux } from '@aptre/yamux'
import { pipe } from 'it-pipe'
import { duplexPair } from 'it-pair/duplex'
import all from 'it-all'

// Connect two yamux muxers to demo basic stream multiplexing functionality

const clientMuxer = yamux({
  client: true,
  onIncomingStream: stream => {
    // echo data on incoming streams
    pipe(stream, stream)
  },
  onStreamEnd: stream => {
    // do nothing
  }
})()

const serverMuxer = yamux({
  client: false,
  onIncomingStream: stream => {
    // echo data on incoming streams
    pipe(stream, stream)
  },
  onStreamEnd: stream => {
    // do nothing
  }
})()

// `p` is our "connections", what we use to connect the two sides
// In a real application, a connection is usually to a remote computer
const p = duplexPair()

// connect the muxers together
pipe(p[0], clientMuxer, p[0])
pipe(p[1], serverMuxer, p[1])

// now either side can open streams
const stream0 = clientMuxer.newStream()
const stream1 = serverMuxer.newStream()

// Send some data to the other side
const encoder = new TextEncoder()
const data = [encoder.encode('hello'), encoder.encode('world')]
pipe(data, stream0)

// Receive data back
const result = await pipe(stream0, all)

// close a stream
stream1.close()

// close the muxer
clientMuxer.close()
```

# 安装

```console
$ npm i @aptre/yamux
```

或者说

```console
$ yarn add @aptre/yamux
```

# 许可证

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

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

# 捐款

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

## 常见问题

### @aptre/yamux 是什么？

Libp2p 的 Yamux 流多路xer

### 如何安装 @aptre/yamux？

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

### @aptre/yamux 支持 TypeScript 吗？

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

### @aptre/yamux 支持 ESM 还是 CommonJS？

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

### @aptre/yamux 可以商用吗？

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

### @aptre/yamux 的下载量有多少？

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

### @aptre/yamux 还在维护吗？

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