ADM-ZIP for Node.js 技术文档

ADM-ZIP for Node.js 技术文档

【免费下载链接】adm-zip A Javascript implementation of zip for nodejs. Allows user to create or extract zip files both in memory or to/from disk 项目地址: https://gitcode.com/gh_mirrors/ad/adm-zip

---

安装指南

使用npm安装

在您的Node.js环境中，通过npm（Node包管理器）轻松安装ADM-ZIP库，只需执行以下命令：

$ npm install adm-zip

对于那些使用Electron的应用，该库已支持与original-fs的兼容性。如果您遇到与打包工具（如rollup）相关的问题时，可以按照下文所述手动指定文件系统模块。

项目使用说明

基础使用案例

引入ADM-ZIP后，您可以读取、解压缩ZIP文件到磁盘或内存缓冲区，也可以创建新的ZIP文件，添加、修改或删除其中的内容。下面是快速操作示例：

const AdmZip = require("adm-zip");

// 读取ZIP文件
let zip = new AdmZip('./example.zip');
let zipEntries = zip.getEntries(); // 获取所有条目

zipEntries.forEach(entry => {
    console.log(entry.toString());
    if ('desired-entry.txt' === entry.entryName) {
        console.log(zip.readAsText(entry.entryName)); // 读取特定文件文本
    }
});

// 解压文件到指定位置
zip.extractEntryTo('nested/filename.txt', '/output/path/', false, true);
// 或者解压整个ZIP文件
zip.extractAllTo('/extract/path/', true);

// 创建ZIP文件
let zipForCreate = new AdmZip();
zipForCreate.addFile('newfile.txt', Buffer.from('这是文件内容'), '这是一个注释');
zipForCreate.addLocalFile('path/to/local/file.jpg'); // 添加本地文件
const outputFileBuffer = zipForCreate.toBuffer(); // 转为Buffer
// 或保存至磁盘
zipForCreate.writeZip('createdzip.zip');

更多详细示例可查看wiki页面。

Electron与original-fs的支持

为了在Electron应用中使用原始的文件系统操作，或解决与某些打包工具的兼容性问题，您可以在初始化ADM-ZIP实例时，明确指定文件系统模块：

const AdmZip = require("adm-zip");
const OriginalFs = require("original-fs");

// 初始化时指定fs选项
const zipWithCustomFs = new AdmZip('./my_file.zip', { fs: OriginalFs });

项目API使用文档

本文档提供的基础示例已经涵盖了大部分日常使用的API。对于更深入的API使用详情，如AdmZip类的方法和属性，建议查阅项目的官方Wiki，那里提供了详尽的API说明和额外功能的使用方法。

项目安装方式

再次重申，要安装ADM-ZIP到您的Node.js项目中，执行这个npm命令即可：

$ npm install adm-zip

这将下载并安装ADM-ZIP及其任何必要的依赖项，使得您能够在Node.js项目中使用ZIP数据处理的功能。

---

以上就是对ADM-ZIP for Node.js的简明技术文档，希望对您理解和使用这个库有所帮助。在实际应用过程中，查阅详细的GitHub仓库和Wiki页面能获取最新信息和技术支持。

【免费下载链接】adm-zip A Javascript implementation of zip for nodejs. Allows user to create or extract zip files both in memory or to/from disk 项目地址: https://gitcode.com/gh_mirrors/ad/adm-zip