Archiver, v1.0.4

Lets you archive files and directories.

Other Versions

1.1.0, 1.0.5, 1.0.4, 1.0.3

BrowserPlus.Archiver.archive({params}, function{}())

Create a archive file from a list of file handles. Service returns a "archiveFile" filehandle for the resulting archive file.

Test: archive()

Parameters

files: list
A list of filehandles to be added to the archive.
format: string
Archive format, one of 'zip', 'zip-uncompressed', 'tar', 'tar-gzip', or 'tar-bzip2'. The archiveFileName suffixes will be '.zip', '.zip', '.tar.gz', and '.tar.bz2' respectively.
archiveFileName: string (Optional)
Filename for resulting archive file. An appropriate suffix will be appended if necessary, as documented under the 'format' argument.
followLinks: boolean (Optional)
If true, links (symbolic links, shortcuts, aliases) will be followed, otherwise the link itself will be archived. Default is false. Symbolic links cannot be archived in the zip formats. Symbolic links are not archived on Windows, and aliases are not archived on OSX.
progressCallback: callback (Optional)
An optional progress callback which is passed an object with the following key: (percent, an integer). The callback is guaranteed to called with percent values of 0 and 100 (unless an error occurs).