Skip to content
a streaming interface for archive generation
Branch: master
Clone or download
Latest commit b30a99b Mar 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
benchmark Small fixes (#339) Aug 22, 2018
examples Remove unused variables in examples (#298) Jan 10, 2018
lib Update zip.js Mar 15, 2019
test Small fixes (#339) Aug 22, 2018
.gitignore add package-lock.json Aug 10, 2018
.travis.yml stop testing for node 4 (LTS) (#341) Aug 22, 2018
CHANGELOG.md bump for release. Aug 22, 2018
CONTRIBUTING.md update docs and examples. Jan 12, 2013
LICENSE
README.md Update README.md Mar 15, 2019
appveyor.yml stop testing node 4 on appveyor. Aug 22, 2018
deploy-docs.sh
index.js
jsdoc.json update jsdoc config. Aug 27, 2016
netlify.toml Update netlify.toml Mar 15, 2019
package-lock.json update jsdoc and related deploy script. Aug 23, 2018
package.json update jsdoc and related deploy script. Aug 23, 2018

README.md

Archiver

Build Status Build status

a streaming interface for archive generation

Visit the API documentation for a list of all methods available.

Install

npm install archiver --save

Quick Start

// require modules
var fs = require('fs');
var archiver = require('archiver');

// create a file to stream archive data to.
var output = fs.createWriteStream(__dirname + '/example.zip');
var archive = archiver('zip', {
  zlib: { level: 9 } // Sets the compression level.
});

// listen for all archive data to be written
// 'close' event is fired only when a file descriptor is involved
output.on('close', function() {
  console.log(archive.pointer() + ' total bytes');
  console.log('archiver has been finalized and the output file descriptor has closed.');
});

// This event is fired when the data source is drained no matter what was the data source.
// It is not part of this library but rather from the NodeJS Stream API.
// @see: https://nodejs.org/api/stream.html#stream_event_end
output.on('end', function() {
  console.log('Data has been drained');
});

// good practice to catch warnings (ie stat failures and other non-blocking errors)
archive.on('warning', function(err) {
  if (err.code === 'ENOENT') {
    // log warning
  } else {
    // throw error
    throw err;
  }
});

// good practice to catch this error explicitly
archive.on('error', function(err) {
  throw err;
});

// pipe archive data to the file
archive.pipe(output);

// append a file from stream
var file1 = __dirname + '/file1.txt';
archive.append(fs.createReadStream(file1), { name: 'file1.txt' });

// append a file from string
archive.append('string cheese!', { name: 'file2.txt' });

// append a file from buffer
var buffer3 = Buffer.from('buff it!');
archive.append(buffer3, { name: 'file3.txt' });

// append a file
archive.file('file1.txt', { name: 'file4.txt' });

// append files from a sub-directory and naming it `new-subdir` within the archive
archive.directory('subdir/', 'new-subdir');

// append files from a sub-directory, putting its contents at the root of archive
archive.directory('subdir/', false);

// append files from a glob pattern
archive.glob('subdir/*.txt');

// finalize the archive (ie we are done appending files but streams have to finish yet)
// 'close', 'end' or 'finish' may be fired right after calling this method so register to them beforehand
archive.finalize();

Formats

Archiver ships with out of the box support for TAR and ZIP archives.

You can register additional formats with registerFormat.

Formats will be changing in the next few releases to implement a middleware approach.

You can’t perform that action at this time.