(Node.js) Add Files to a ZIP Using AddFile

See more Zip Examples

This example demonstrates how to use the AddFile method to add files from the local filesystem to a ZIP archive.

The example adds two files:

• One file with its relative directory path preserved
• One file stored using only its filename

The AddFile method adds references to local filesystem files. The files are not actually read or compressed until a Write* method is called.

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOS

var os = require('os');
if (os.platform() == 'win32') {  
  var chilkat = require('@chilkat/ck-node23-win64'); 
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node23-linux-arm');
    } else if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node23-linux-arm64');
    } else {
        var chilkat = require('@chilkat/ck-node23-linux-x64');
    }
} else if (os.platform() == 'darwin') {
  var chilkat = require('@chilkat/ck-node23-mac-universal');
}

function chilkatExample() {

    var success = false;

    var zip = new chilkat.Zip();

    success = zip.NewZip("addFileExample.zip");
    if (success == false) {
        console.log(zip.LastErrorText);
        return;
    }

    // Add a file and preserve its relative directory structure
    // within the ZIP archive.
    // 
    // The following file:
    //     c:/projects/app/docs/readme.txt
    // 
    // Will be stored in the ZIP as:
    //     projects/app/docs/readme.txt
    // 
    var saveExtraPath = true;
    success = zip.AddFile("c:/projects/app/docs/readme.txt",saveExtraPath);
    if (success == false) {
        console.log(zip.LastErrorText);
        return;
    }

    // Add a file using only the filename in the ZIP archive.
    // 
    // The following file:
    //     c:/temp/logo.png
    // 
    // Will be stored in the ZIP as:
    //     logo.png
    // 
    saveExtraPath = false;
    success = zip.AddFile("c:/temp/logo.png",saveExtraPath);
    if (success == false) {
        console.log(zip.LastErrorText);
        return;
    }

    // Write the ZIP archive to disk and close it.
    // The source files are consumed at this time.
    success = zip.WriteZipAndClose();
    if (success == false) {
        console.log(zip.LastErrorText);
        return;
    }

    console.log("ZIP archive created successfully.");

}

chilkatExample();