# @cookielab\.io/stream-async-wrappers 中文文档

规范地址：https://npmcn.com/package/%40cookielab.io/stream-async-wrappers/

版本：0\.5\.0
npm 元数据更新时间：2025-06-17T11:57:29.413Z
中文译文更新时间：2026-11-10T17:52:19.150Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40cookielab.io/stream-async-wrappers
原文对照：https://npmcn.com/package/%40cookielab.io/stream-async-wrappers/?lang=original
项目主页：https://gitlab.com/cookielab/nodejs-stream-async-wrappers#readme
源码仓库：https://gitlab.com/cookielab/nodejs-stream-async-wrappers

弃用说明：Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

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

- 包体积（解压后）：11.5 kB，13 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=10\.13\.0
- 运行依赖：1 个
- 首次发布：2018-04-30T12:43:25.787Z
- 最新版本发布：2020-06-17T14:04:24.959Z
- 近 30 天下载量：58568（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 0 个）

## 中文简介

## 安装

## 安装

```sh
npm install @cookielab.io/stream-async-wrappers
```

也可以使用：`pnpm add @cookielab.io/stream-async-wrappers`、`yarn add @cookielab.io/stream-async-wrappers`、`bun add @cookielab.io/stream-async-wrappers`

## README

# 串流自动交换器

## 安装

```sh
$ yarn add @cookielab.io/stream-async-wrappers
```

## 使用量

### 从流中读取数据

```typescript
import {ReadableStreamAsyncReader} from '@cookielab.io/stream-async-wrappers';

const reader = new ReadableStreamAsyncReader(stream); // wrap readable stream

const chunk = await reader.read(); // read chunk of data
```

### 将数据写入流中

```typescript
import {WritableStreamAsyncReader} from '@cookielab.io/stream-async-wrappers';

const writer = new WritableStreamAsyncWriter(stream);

await writer.write(chunk); // write chunk of data

await writer.end(); // ends wrapped write stream
```

## API 密码

###### `new WritableStreamAsyncWriter(stream: Writable)`

通过包接节点来创建编剧实例 `Writable` 流线.

###### `writableStreamAsyncWriter.write(chunk: string | Buffer | any, encoding?: string, callback?: (error?: Error | null) => void): Promise<void>`

将给定的数据块写入被包裹的流中 . 返回的承诺将在数据成功写入包裹的写流后解决. 当写入失败时, 返回的诺言会以错误拒绝 . 可选的回调参数在返回的许诺解决或拒绝之前被调用.

###### `writableStreamAsyncWriter.end(callback?: (error?: Error | null) => void): Promise<void>`

在所有数据成功写入流后结束所包裹的写入流. 返回的诺言将在溪流成功完成后解决. 当写出或结束失败时, 返回的许诺会以错误拒绝 .

###### `new ReadableStreamAsyncReader(stream: Readable)`

通过包裹节点创建阅读器实例 `Readable` 流线.

###### `readableStreamAsyncReader.read(size?: number): Promise<Chunk | null | undefined>`

从被包裹的溪流读取块数据 . 可选的大小参数可以用来指定要读取多少数据. 返回的承诺一旦得到读取的数据就会得到解决. 当读取失败时, 返回的承诺会以错误拒绝 .

## 常见问题

### @cookielab\.io/stream-async-wrappers 是什么？

安装注意：该包已被作者标记为弃用——Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

### 如何安装 @cookielab\.io/stream-async-wrappers？

在项目目录运行 npm install @cookielab\.io/stream-async-wrappers，或使用 pnpm add / yarn add / bun add。

### @cookielab\.io/stream-async-wrappers 支持 TypeScript 吗？

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

### @cookielab\.io/stream-async-wrappers 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @cookielab\.io/stream-async-wrappers 需要什么版本的 Node\.js？

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

### @cookielab\.io/stream-async-wrappers 可以商用吗？

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

### @cookielab\.io/stream-async-wrappers 的下载量有多少？

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

### @cookielab\.io/stream-async-wrappers 还在维护吗？

最新版本 0\.5\.0 发布于 2020/06/17（6 年前）；至今共发布 6 个版本，其中过去 12 个月发布了 0 个；首次发布于 2018/04/30。作者已将其标记为弃用，新项目建议寻找替代方案。