https://github.com/cthackers/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://github.com/cthackers/adm-zip

Last synced: 4 days ago
JSON representation

A Javascript implementation of zip for nodejs. Allows user to create or extract zip files both in memory or to/from disk

• Host: GitHub
• URL: https://github.com/cthackers/adm-zip
• Owner: cthackers
• License: mit
• Created: 2012-02-22T14:06:15.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2024-09-22T17:10:53.000Z (5 months ago)
• Last Synced: 2025-02-03T22:27:57.825Z (11 days ago)
• Language: JavaScript
• Homepage:
• Size: 1.05 MB
• Stars: 2,075
• Watchers: 40
• Forks: 375
• Open Issues: 141
• Metadata Files:
  • Readme: README.md
  • Changelog: history.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-nodejs - adm-zip - Create, read and edit .zip files with Javascript.  (Repository / File Compression / Decompression)

README

        
# ADM-ZIP for NodeJS

ADM-ZIP is a pure JavaScript implementation for zip data compression for [NodeJS](https://nodejs.org/).



  



# Installation

With [npm](https://www.npmjs.com/) do:

    $ npm install adm-zip

**Electron** file system support described below.

## What is it good for?

The library allows you to:

-   decompress zip files directly to disk or in memory buffers

-   compress files and store them to disk in .zip format or in compressed buffers

-   update content of/add new/delete files from an existing .zip

# Dependencies

There are no other nodeJS libraries that ADM-ZIP is dependent of

# Examples

## Basic usage

```javascript

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

// reading archives

var zip = new AdmZip("./my_file.zip");

var password = "1234567890";

var zipEntries = zip.getEntries(); // an array of ZipEntry records - add password parameter if entries are password protected

zipEntries.forEach(function (zipEntry) {

    console.log(zipEntry.toString()); // outputs zip entries information

    if (zipEntry.entryName == "my_file.txt") {

        console.log(zipEntry.getData().toString("utf8"));

    }

});

// outputs the content of some_folder/my_file.txt

console.log(zip.readAsText("some_folder/my_file.txt"));

// extracts the specified file to the specified location

zip.extractEntryTo(/*entry name*/ "some_folder/my_file.txt", /*target path*/ "/home/me/tempfolder", /*maintainEntryPath*/ false, /*overwrite*/ true);

// extracts everything

zip.extractAllTo(/*target path*/ "/home/me/zipcontent/", /*overwrite*/ true);

// creating archives

var zip = new AdmZip();

// add file directly

var content = "inner content of the file";

zip.addFile("test.txt", Buffer.from(content, "utf8"), "entry comment goes here");

// add local file

zip.addLocalFile("/home/me/some_picture.png");

// get everything as a buffer

var willSendthis = zip.toBuffer();

// or write everything to disk

zip.writeZip(/*target file name*/ "/home/me/files.zip");

// ... more examples in the wiki

```

For more detailed information please check out the [wiki](https://github.com/cthackers/adm-zip/wiki).

## Electron original-fs

ADM-ZIP has supported electron **original-fs** for years without any user interractions but it causes problem with bundlers like rollup etc. For continuing support **original-fs** or any other custom file system module. There is possible specify your module by **fs** option in ADM-ZIP constructor.

Example:

```javascript

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

const OriginalFs = require("original-fs");

// reading archives

const zip = new AdmZip("./my_file.zip", { fs: OriginalFs });

.

.

.

```