(Node.js) Extract a Single ZIP Entry While Preserving Its Stored Path

See more Zip Examples

This example demonstrates how to use the ZipEntry.Extract method to extract a single entry from a ZIP archive.

The example first creates a ZIP archive containing a text file. It then re-opens the ZIP, finds the entry, and extracts it to a base directory.

The Extract method uses the relative path stored within the ZIP entry. Any required subdirectories are created automatically beneath the specified base directory.

Note: This example requires Chilkat v11.0.0 or greater.

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;

    // ------------------------------------------------------------
    // First create a sample ZIP archive containing a small text file.

    var zip = new chilkat.Zip();

    success = zip.NewZip("c:/temp/sampleText.zip");
    if (success == false) {
        console.log(zip.LastErrorText);
        return;
    }

    // Add a small text file from memory.
    success = zip.AddString("myApp/docs/hello.txt","Hello from a ZIP entry!","utf-8");
    if (success == false) {
        console.log(zip.LastErrorText);
        return;
    }

    // Write the ZIP archive to disk and close it.
    success = zip.WriteZipAndClose();
    if (success == false) {
        console.log(zip.LastErrorText);
        return;
    }

    // ------------------------------------------------------------
    // Now open the ZIP archive we just created.

    var zip2 = new chilkat.Zip();

    success = zip2.OpenZip("c:/temp/sampleText.zip");
    if (success == false) {
        console.log(zip2.LastErrorText);
        return;
    }

    // Find the entry by its stored ZIP path.
    var entry = new chilkat.ZipEntry();

    success = zip2.EntryOf("myApp/docs/hello.txt",entry);

    if (success == false) {
        console.log("Entry not found.");
        return;
    }

    // Extract this single entry to the base directory:
    // 
    //     c:/temp/extracted
    // 
    // Because the entry's stored path is:
    // 
    //     myApp/docs/hello.txt
    // 
    // the file will be extracted to:
    // 
    //     qa_output/extracted/myApp/docs/hello.txt
    // 
    // The required subdirectories are created automatically.
    success = entry.Extract("c:/temp/extracted");
    if (success == false) {
        console.log(entry.LastErrorText);
        return;
    }

    zip2.CloseZip();

    console.log("Entry extracted successfully.");

}

chilkatExample();