Creating and Managing ZIP Archives in Node.js and Browser Environments
These libraries provide tools for compressing and extracting ZIP files within JavaScript applications. adm-zip, archiver, and jszip are the core engines, while node-zip, zip-a-folder, and zip-local serve as wrappers or legacy alternatives. They differ significantly in execution model — synchronous, streaming, or asynchronous — and environment support, with some working only on servers and others running in browsers. Choosing the right one depends on whether you need to handle large files, support client-side users, or maintain legacy code.
Npm Package Weekly Downloads Trend
Github Stars Ranking
Stat Detail
Creating ZIP Archives: Architecture and API Comparison
These six packages handle ZIP compression in JavaScript, but they differ in how they run, where they work, and their maintenance status. Some are built for servers, others for browsers, and some are no longer safe to use. Let's compare how they tackle common tasks.
⚙️ Execution Model: Sync vs Stream vs Async
adm-zip works mostly in a synchronous way.
- It blocks the code until the ZIP is done.
- Good for small scripts where speed matters less than simplicity.
// adm-zip: Synchronous API
const AdmZip = require("adm-zip");
const zip = new AdmZip();
zip.addLocalFile("input.txt");
zip.writeZip("output.zip"); // Blocks here
archiver uses streams to handle data.
- It pipes data through without loading everything into memory.
- Best for large files on a server.
// archiver: Streaming API
const archiver = require("archiver");
const output = fs.createWriteStream("output.zip");
const archive = archiver("zip");
archive.pipe(output);
archive.file("input.txt", { name: "inside.txt" });
archive.finalize(); // Ends the stream
jszip relies on Promises and async code.
- It does not block the main thread while working.
- Ideal for browsers or non-blocking server tasks.
// jszip: Async/Promise API
const JSZip = require("jszip");
const zip = new JSZip();
zip.file("input.txt", "content");
zip.generateAsync({ type: "nodebuffer" }).then(function (content) {
// Handle result
});
node-zip uses a synchronous legacy model.
- It blocks execution like
adm-zip. - Warning: This package is deprecated and should not be used.
// node-zip: Deprecated Sync API
const Zip = require("node-zip");
const zip = new Zip();
zip.add("input.txt", "content");
const data = zip.generate({ type: "nodebuffer" }); // Legacy method
zip-a-folder wraps other tools with async functions.
- It returns a Promise when finished.
- Simplifies zipping whole directories.
// zip-a-folder: Async Wrapper
const zipFolder = require("zip-a-folder");
await zipFolder("src_folder", "output.zip"); // Returns Promise
zip-local provides a synchronous helper interface.
- It chains methods to zip and save in one go.
- Less flexible than using the core libraries directly.
// zip-local: Sync Chain API
const zip = require("zip-local").sync;
zip.zip("input.txt").compress().save("output.zip"); // Sync chain
🌍 Environment Support: Server vs Browser
adm-zip runs only on Node.js servers.
- It uses file system paths directly.
- Cannot run in a web browser context.
// adm-zip: Node.js only
// Uses fs module internally
zip.addLocalFile("./path/on/server.txt");
archiver runs only on Node.js servers.
- It depends on Node streams.
- Not suitable for client-side code.
// archiver: Node.js only
// Requires fs.createWriteStream
archive.pipe(fs.createWriteStream("out.zip"));
jszip runs on both Node.js and browsers.
- It works with buffers and binary strings.
- The only choice here for client-side zipping.
// jszip: Universal
// Works in browser console or Node
zip.file("hello.txt", "Hello World\n");
node-zip was designed for Node.js.
- It does not support modern browser environments.
- Deprecated status limits its use case further.
// node-zip: Node.js legacy
// No browser support
zip.add("file", "data");
zip-a-folder runs on Node.js servers.
- It accesses the file system to read folders.
- Cannot access local user folders in a browser.
// zip-a-folder: Node.js only
await zipFolder("/server/path", "out.zip");
zip-local runs on Node.js servers.
- It wraps Node file system calls.
- Not built for client-side execution.
// zip-local: Node.js only
zip.zip("/server/path").save("out.zip");
⚠️ Maintenance and Safety
adm-zip is actively maintained.
- It receives updates for security and bugs.
- Safe for production server use.
archiver is actively maintained.
- It is the standard for streaming archives.
- Highly reliable for backend services.
jszip is actively maintained.
- It is the standard for browser compression.
- Regular updates for performance and security.
node-zip is officially deprecated.
- Do not use this in new projects.
- It has known issues and no future support.
zip-a-folder has limited maintenance.
- It depends on the health of its underlying libraries.
- Use with caution for critical systems.
zip-local has low activity.
- It may not receive security patches quickly.
- Prefer
adm-ziporjszipfor long-term projects.
📊 Summary: Key Differences
| Package | Model | Environment | Status |
|---|---|---|---|
adm-zip | Sync | Node.js | ✅ Active |
archiver | Stream | Node.js | ✅ Active |
jszip | Async | Both | ✅ Active |
node-zip | Sync | Node.js | ❌ Deprecated |
zip-a-folder | Async | Node.js | ⚠️ Wrapper |
zip-local | Sync | Node.js | ⚠️ Low Activity |
💡 The Big Picture
jszip is the go-to for browsers — it works everywhere and handles async tasks well.
archiver is the best for servers — it streams data so you do not run out of memory.
adm-zip is good for simple scripts — it is easy to read and write quickly.
node-zip should be avoided — it is deprecated and unsafe for new work.
Final Thought: Pick jszip for universal needs, archiver for large server files, and adm-zip for quick synchronous tasks. Avoid the deprecated options to keep your project secure.
How to Choose: adm-zip vs archiver vs jszip vs node-zip vs zip-a-folder vs zip-local
- adm-zip:
Choose
adm-zipif you need a simple synchronous API for Node.js scripts that handle small to medium files. It is easy to read and requires minimal setup for basic zipping tasks. However, avoid it for large files because it loads everything into memory at once. It is best suited for build tools or backend utilities where blocking the thread is acceptable. - archiver:
Choose
archiverif you are building a Node.js server that needs to stream large files without running out of memory. It pipes data directly to disk or network streams efficiently. This makes it ideal for generating downloads on the fly or handling big datasets. It requires more setup than synchronous tools but offers better performance for heavy workloads. - jszip:
Choose
jszipif you need to create or read ZIP files inside a web browser or require non-blocking async code in Node.js. It is the only option here that works universally across environments. It handles data in memory using Promises, which keeps your application responsive. Use this for client-side exports or when you need to manipulate archive contents before saving. - node-zip:
Do not choose
node-zipfor any new project because it is officially deprecated and unmaintained. It lacks modern security patches and feature updates required for production use. Existing projects using it should plan a migration tojsziporadm-zip. Relying on this package introduces unnecessary risk to your software supply chain. - zip-a-folder:
Choose
zip-a-folderif you need a quick utility to compress an entire directory in Node.js without writing boilerplate code. It wraps underlying libraries to provide a simple Promise-based interface. This is useful for one-off scripts or deployment tasks where speed of development matters. For complex archive manipulation, prefer a core library likearchiverinstead. - zip-local:
Choose
zip-localonly if you are maintaining legacy code that already depends on its specific synchronous chain API. It offers a convenient way to zip and save in one line for Node.js environments. However, it has low maintenance activity compared to core alternatives. For new development, selectadm-ziporjszipto ensure long-term support and security.
Popular Comparisons
README for adm-zip
ADM-ZIP for NodeJS
ADM-ZIP is a pure JavaScript implementation for zip data compression for NodeJS.
Installation
With npm 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
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.
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:
const AdmZip = require("adm-zip");
const OriginalFs = require("original-fs");
// reading archives
const zip = new AdmZip("./my_file.zip", { fs: OriginalFs });
.
.
.