# @borgar/zip 中文文档

规范地址：https://npmcn.com/package/%40borgar/zip/

版本：1\.1\.0
npm 元数据更新时间：2026-11-07T16:37:50.700Z
中文译文更新时间：2026-11-08T11:40:17.473Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：73.2 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-05-04T11:48:12.888Z
- 最新版本发布：2026-11-07T16:37:50.561Z
- 近 30 天下载量：6998（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

一个用于操纵zip文件的库,在可用的情况下使用本地执行来压缩.

## 安装

```sh
npm install @borgar/zip
```

也可以使用：`pnpm add @borgar/zip`、`yarn add @borgar/zip`、`bun add @borgar/zip`

## README

# 翻译:

一个用于读取和写作ZIP档案的图书馆,在有条件的地方使用本地平台API进行压缩.

-   使用本地平台实施zlib/deflate(几乎无所不在), 只有在其他失败时才回到联署机构.
    
-   QQ在内存中保持拉链压缩,而不是在负载上扩展所有.
    
-   校对:Soup.
    
-   满打字为方便.
    

## 安装

```bash
npm install @borgar/zip
```

## 使用量

```js
import { ZipArchive } from '@borgar/zip';

// Read an existing archive
const zip = new ZipArchive(arrayBuffer);
const text = await zip.readText('hello.txt'); // "hello world\n"
const data = await zip.read('image.png'); // ArrayBuffer([ 89 50 4E 47 0D 0A 1A 0A... ])

// Create a new archive
const zip = new ZipArchive();
await zip.write('hello.txt', text);
await zip.write('data.bin', data);

// Or write without awaiting each call. Entries are added in call order.
zip.write('a.txt', 'a');
zip.write('b.txt', 'b');
await zip.done(); // waits for all pending writes

const output = zip.toArrayBuffer();

// Trigger a browser download
const zipBlob = new Blob([ output ]);
const urlObject = URL.createObjectURL(zipBlob);
const a = document.createElement('a');
a.href = urlObject;
a.download = 'MyFilename.zip';
a.click();
URL.revokeObjectURL(urlObject);
```

## API 密码

API 完全记录在 [API.md (英语)](https://npmcn.com/package/%40borgar/zip/API.md)。 。 。 .

## 常见问题

### @borgar/zip 是什么？

一个用于操纵zip文件的库,在可用的情况下使用本地执行来压缩\.

### 如何安装 @borgar/zip？

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

### @borgar/zip 支持 TypeScript 吗？

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

### @borgar/zip 支持 ESM 还是 CommonJS？

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

### @borgar/zip 可以商用吗？

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

### @borgar/zip 的下载量有多少？

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

### @borgar/zip 还在维护吗？

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