Documentation

Module: Zip

Zip lib

Methods

<static> packFile(path [, options])

Pack a single file
Parameters:
Name Type Argument Description
path String Origin file path
options Object <optional>
Properties
Name Type Argument Description
destination String <optional>
 Output directory, the default is the origin file directory
targetName String <optional>
 Zip file name, the default is the origin file name
override Boolean <optional>
 Override destination file, default is false
suffixMask (String=} If override is set to false, set the date format to use as suffix in targetName, default is 'YYYY-MM-DDTHH-mm-ss'
Returns:
Type
EventEmitter

<static> packFiles(pathList [, options])

Pack multiple files into a single zip
Parameters:
Name Type Argument Description
pathList Array Origin file paths
options Object <optional>
Properties
Name Type Argument Description
destination String <optional>
 Output directory, the default is the origin file directory
targetName String <optional>
 Zip file name, the default is the origin file name
override Boolean <optional>
 Override destination file, default is false
suffixMask (String=} If override is set to false, set the date format to use as suffix in targetName, default is 'YYYY-MM-DDTHH-mm-ss'
Returns:
Type
EventEmitter