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

npm install archiver --save

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

Convenience alias for create.

Creates an Archiver instance based on the type (ie zip/tar) passed.

Alias of append for compatibility that will be removed down the road.

Appends a file to the instance. Input can be in the form of a text string, buffer, or stream. When the instance has received, processed, and emitted the input, the callback is fired.

Finalizes the instance. When the instance's stream has finished emitting, the callback is fired.

Sets the zip comment.

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

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

Sets the file name including internal path.

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

If true, file contents will be stored without compression.

Sets the file comment.

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

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

Sets the file name including internal path.

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

Take a peek at the examples folder for a complete listing.

see CONTRIBUTING.

see CHANGELOG.

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

This project's code is licensed under the MIT license. see LICENSE-MIT.