Archiver v0.4.9
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(type, options)
Creates an Archiver instance based on the type (ie zip/tar) passed. Can be passed to Archiver
for convenience.
Instance Methods
#append(input, data, callback(err))
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.
Replaces #addFile
which is in the depreciation stage and set to be remove in next release.
#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
string
comment Sets the zip comment.
boolean
forceUTC If true, forces the file date and time to UTC. Helps with testing across timezones.
object
zlib Passed to node's zlib module to control compression. Options may vary by node version.
File Data
string
required
name Sets the file name including internal path.
string|Date
date Sets the file date. This can be any valid date string or instance. Defaults to current time in locale.
boolean
store If true, file contents will be stored without compression.
string
comment Sets the file comment.
Tar
Options
number
recordSize Sets the size (in bytes) of each record in a block, default is 512 (for advanced users only).
number
recordsPerBlock Sets the number of records in a block, default is 20 (for advanced users only).
File Data
string
required
name Sets the file name including internal path.
string|Date
date Sets the file date. This can be any valid date string or instance. Defaults to current time in locale.
Things of Interest
Credits
Concept inspired by Antoine van Wel's node-zipstream.
Tar inspired by isaacs's node-tar.