Zips up a directory and saves the zip archive to disk or returns as a buffer.
This fork enhances the original project with the following functionality:
- Depends on the most recent versions of
jszipand other packages.
- Supports both callback and
Promiseto notify about the finished work.
- Offers extra parameters
$ npm install @prantlf/zip-dir
var zipdir = ;// `buffer` is the buffer of the zipped filevar buffer = await ;;;;// Use a filter option to prevent zipping other zip files!// Keep in mind you have to allow a directory to descend into!;// Use an `each` option to call a function everytime a file is added, and receives the path
var zipdir = require('@prantlf/zip-dir');
zipdir(dirPath, [options], [callback]) : [Promise]
dirPath recursively preserving directory structure and returns
the compressed buffer on success. If the
callback function is supplied, it will be called with
(error, buffer) once the
zipdir function is done. If not, the buffer or an error can be obtained from the returned promise. The
callback and the promise are mutually exclusive. If
options defined with a
saveTo path, then the callback and promise will be delayed until the buffer has also
been saved to disk.
rootPathFolder path to create in the root of the zip file and place the input files and folder below it. Input files and folders will be placed directly to the zip file root by default.
saveToA path to save the buffer to.
filterA function that is called for all items to determine whether or not they should be added to the zip buffer. Function is called with the
statsobject (fs.Stats). Return true to add the item; false otherwise. To include files within directories, directories must also pass this filter.
eachA function that is called everytime a file or directory is added to the zip.
commentA comment to be stored to the zip file.
compressionLevelThe level of compression to use. A number from 1 (best speed) and 9 (best compression). 6 is the default.
omitEmptyDirsPrevents empty directories from being included in the zip file. If the root folder to pack is empty, the whole operation will fail.
allowEmptyRootLets the empty root directory be included in the zip file, if the
omitEmptyDirsis set to