ADM ZIP Introduction

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

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 decompression

	var Zip = require('adm-zip').Zip;

	// reading archives
	var file = new Zip("my_file.zip");
	var zipEntries = file.getEntries(); // an array of ZipEntry records

	zipEntries.forEach(function(zipEntry) {
	    console.log(zipEntry.toString()); 
		// outputs zip entries information
	});
	
	// outputs the content of some_folder/my_file.txt
	console.log(file.readAsText("some_folder/my_file.txt")); 
	
	// extracts the specified file to the specified location
	file.extractEntryTo("some_folder/my_file.txt", "/home/me/tempfolder", true)
	
	// extracts everything
	file.extractAllTo("/home/me/zipcontent/", true);
	
	// ... more examples in the wiki