ff-unzip/readme.md

基于 fflate 的零依赖轻量级 ZIP 解压工具，支持命令行使用和 Node.js API 调用。

# ff-unzip

基于 [fflate](https://www.npmjs.com/package/fflate) 的 **0 依赖** 轻量级 zip 解压工具。

包名来源：**ff** 来自 fflate，结合 **unzip**。

---

## ✨ 功能特性

* 🚀 无任何外部依赖
* 📦 命令行解压 zip 文件
* 🛠️ 提供函数调用接口，方便集成到 Node.js 项目中

---

## 📦 安装

无需全局安装，可直接使用 **npx**。
如需项目内使用，也可通过 npm/yarn/pnpm 安装：

```bash
npm install ff-unzip
# 或者
yarn add ff-unzip
# 或者
pnpm add ff-unzip
```

---

## 🚀 使用方法

### 命令行工具

解压 zip 文件：

```bash
npx ff-unzip <zipPath> -d <destDir>
```

示例：

```bash
npx ff-unzip ./archive.zip -d ./output
```

---

### Node.js API

```ts
import { fflatUnzip } from "ff-unzip";

fflatUnzip("archive.zip", "outputDir");
```

参数说明：

* `zipPath: string` → zip 文件路径
* `outputDir: string` → 解压目标目录