qie.createZipFile

Signature: qie.createZipFile(directory, zipFile, includeSubDirectories*)

Returns: Boolean succeeded - true if the operation completes successfully

Compresses the contents of the directory new a new zipFile.

Parameters

Type	Name	Description	Default
String or File	directory	the folder or file to be compressed into the zipFile
String or File	zipFile	the new zip file containing the contents of the directory
Boolean	includeSubDirectories*	(optional) true, to include the sub-directories in the zip file	false

Example

// Create Zip File Examples:
// Example: directory as String path, zipFile as String path
qie.writeFile("/tmp/letters/a.txt", "A is for apples.", true);
qie.writeFile("/tmp/letters/b.txt", "B is for baby.", true);

var success = qie.createZipFile(
   "/tmp/letters",
   "/tmp/letters.zip",
   true
);
// letters.zip will contain both a.txt and b.txt (including subdirectories)


// Example: directory as File, zipFile as File
var dirFile = qie.newFile("/tmp/letters-file");
qie.writeFile("/tmp/letters-file/c.txt", "C is for cat.", true);

var zipFileObject = qie.newFile("/tmp/letters-file.zip");
var successWithFiles = qie.createZipFile(
   dirFile,
   zipFileObject,
   true
);


// Example: directory as String path, zipFile as File
var successWithStringDirectory = qie.createZipFile(
   "/tmp/letters",
   qie.newFile("/tmp/letters-mixed1.zip"),
   false
);


// Example: directory as File, zipFile as String path
var successWithStringZipFile = qie.createZipFile(
   qie.newFile("/tmp/letters-file"),
   "/tmp/letters-mixed2.zip",
   false
);