Archiver v0.5.0-alpha

Creates Archives (Zip, Tar) via Node Streams. Depends on Node's built-in zlib module for compression available since version 0.6.3.

Install

npm install archiver --save

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

Archiver

create(format, options)

Creates an Archiver instance based on the format (zip, tar, etc) passed. Parameters can be passed directly to Archiver constructor for convenience.

registerFormat(format, module)

Registers an archive format. Format modules are essentially transform streams with a few required methods. They will be further documented once a formal spec is in place.

Instance Methods

append(input, data, callback(err))

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.

Replaced #addFile in v0.5.

archive.append('string', { name:'string.txt' });
archive.append(new Buffer('string'), { name:'buffer.txt' });
archive.append(fs.createReadStream('mydir/file.txt'), { name:'stream.txt' });

bulk(mappings)

Appends multiple files from passed array of src-dest file mappings, based on Grunt's "Files Array" format. A lazystream wrapper is used to prevent issues with open file limits.

Globbing patterns and multiple properties are supported through use of the file-utils package, based on Grunt's file utilities. Please note that multiple src files to single dest file (ie concat) is not supported.

The data property can be set (per src-dest mapping) to define file data for matched files.

archive.bulk([
  { src: ['mydir/**'], data: { date: new Date() } },
  { expand: true, cwd: 'mydir', src: ['**'], dest: 'newdir' }
]);

file(filepath, data, callback(err))

Appends a file given its filepath. Uses a lazystream wrapper to prevent issues with open file limits.

archive.file('mydir/file.txt', { name:'file.txt' });

finalize(callback(err, bytes))

Finalizes the instance. When the instance's stream has finished emitting, the callback is fired. This generally doesn't correspond to the end of the destination stream; though a solution to track the destination stream may come in a future release.

Zip

Options

comment string

Sets the zip comment.

forceUTC boolean

If true, forces the file date and time to UTC. Helps with testing across timezones.

zlib object

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

File Data

name string required

Sets the file name including internal path.

date string|Date

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

store boolean

If true, file contents will be stored without compression.

comment string

Sets the file comment.

mode number

Sets the file permissions. (experimental)

Tar

Options

recordSize number

Sets the size (in bytes) of each record in a block, default is 512 (for advanced users only).

recordsPerBlock number

Sets the number of records in a block, default is 20 (for advanced users only).

File Data

name string required

Sets the file name including internal path.

date string|Date

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

mode number

Sets the file permissions. Defaults to 0664.

Things of Interest

• Examples
• Changelog
• Archive Formats
• Contributing
• MIT License

Credits

Concept inspired by Antoine van Wel's node-zipstream.

Tar inspired by isaacs's node-tar.