zip-stream

What is zip-stream?

The zip-stream npm package is a streaming zip archive generator. It allows you to compress files and directories on the fly and stream them to the user or save them to disk. It is particularly useful for creating zip files without having to store the entire contents in memory or on disk before sending to the recipient.

What are zip-stream's main functionalities?

Creating a zip archive

This code sample demonstrates how to create a simple zip archive containing a single file with the text 'Hello World!' and the file name 'hello.txt'. The archive is then written to 'path/to/archive.zip'.

const ZipStream = require('zip-stream');
const fs = require('fs');

const archive = new ZipStream();
const output = fs.createWriteStream('path/to/archive.zip');

archive.pipe(output);

archive.entry('Hello World!', { name: 'hello.txt' }, function(err) {
  if (err) throw err;
  archive.finish();
});

Adding files to a zip archive from a stream

This code sample shows how to add a file to a zip archive from a readable stream. The file 'path/to/file.txt' is streamed and added to the archive under the name 'file.txt'.

const ZipStream = require('zip-stream');
const fs = require('fs');

const archive = new ZipStream();
const output = fs.createWriteStream('path/to/archive.zip');
const fileStream = fs.createReadStream('path/to/file.txt');

archive.pipe(output);

archive.entry(fileStream, { name: 'file.txt' }, function(err) {
  if (err) throw err;
  archive.finish();
});

Adding multiple files and directories

This code sample illustrates how to add multiple files and directories to a zip archive. It adds 'file1.txt' with direct content, streams 'file2.txt' from the file system, and includes an entire directory 'path/to/directory' under the name 'directory' in the archive.

const ZipStream = require('zip-stream');
const fs = require('fs');

const archive = new ZipStream();
const output = fs.createWriteStream('path/to/archive.zip');

archive.pipe(output);

archive.entry('File content', { name: 'file1.txt' }, function(err) {
  if (err) throw err;
  archive.entry(fs.createReadStream('path/to/file2.txt'), { name: 'file2.txt' }, function(err) {
    if (err) throw err;
    archive.directory('path/to/directory', 'directory', function(err) {
      if (err) throw err;
      archive.finish();
    });
  });
});

Other packages similar to zip-stream

archiver

Archiver is a high-level streaming interface for creating archives. It supports multiple archive formats, including ZIP and TAR. It offers more customization options and archive formats compared to zip-stream, which is focused solely on ZIP files.

jszip

JSZip is a library for creating, reading, and editing .zip files with JavaScript, with a focus on client-side use. It differs from zip-stream as it is not stream-based and is designed to work with the entire content in memory, which can be less efficient for large files.

yazl

Yazl is a minimalistic zip library for Node.js. It is similar to zip-stream in that it focuses on ZIP file creation, but it has a simpler API and fewer features. It may be more suitable for straightforward ZIP file creation without the need for streaming capabilities.

README

zip-stream v0.3.5

zip-stream is a streaming zip archive generator. It was built to be a successor to zipstream. Dependencies are kept to a minimum through the use of many of node's built-in modules including the use of zlib module for compression.

Install

npm install zip-stream --save

You can also use npm install https://github.com/ctalkington/node-zip-stream/archive/master.tar.gz to test upcoming versions.

Usage

This module is meant to be wrapped internally by other modules and therefore lacks any queue management. This means you have to wait until the previous entry has been fully consumed to add another. Nested callbacks should be used to add multiple entries. There are modules like async that ease the so called "callback hell".

If you want a module that handles entry queueing and much more, you should check out archiver which uses this module internally.

var packer = require('zip-stream');
var archive = new packer(); // OR new packer(options)

archive.on('error', function(err) {
  throw err;
});

// pipe archive where you want it (ie fs, http, etc)
// listen to the destination's end, close, or finish event

archive.entry('string contents', { name: 'string.txt' }, function(err, entry) {
  if (err) throw err;
  archive.entry(null, { name: 'directory/' }, function(err, entry) {
    if (err) throw err;
    archive.finalize();
  });
});

Instance API

entry(input, data, callback(err, data))

Appends an input source (text string, buffer, or stream) to the instance. When the instance has received, processed, and emitted the input, the callback is fired.

finalize()

Finalizes the instance. You should listen to the destination stream's end/close/finish event to know when all output has been safely consumed.

Instance Options

comment string

Sets the zip comment.

forceUTC boolean

If true, forces the entry date to UTC. Helps with testing across timezones.

store boolean

If true, all entry contents will be archived without compression by default.

zlib object

Passed to node's zlib module to control compression. Options may vary by node version.

Entry Data

name string required

Sets the entry name including internal path.

type string

Sets the entry type. Defaults to file or directory if name ends with trailing slash.

date string|Date

Sets the entry date. This can be any valid date string or instance. Defaults to current time in locale.

store boolean

If true, entry contents will be archived without compression.

comment string

Sets the entry comment.

mode number

Sets the entry permissions. (experimental)

Debugging

This library makes use of the debug module with a namespace of zip-stream which can be triggered by setting DEBUG in your environment like so:

# unix
DEBUG=zip-stream:* node script


# windows (powershell)

$env:DEBUG="zip-stream:*"
node script


# windows (cmd)
SET DEBUG="zip-stream:*"
node script

Things of Interest

• Releases
• Contributing
• MIT License

Credits

Concept inspired by Antoine van Wel's zipstream module, which is no longer being updated.