(Node.js) Create Compressed .tgz (.tar.gz) TAR Archive

Demonstrates how to create a compressed TAR archive containing an entire directory tree. This example creates a compressed archive using GZip compression. The typical file extension used is .tgz or .tar.gz.

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

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var tar = new chilkat.Tar();

    // The TAR component will produce a  GNU tar 1.13.x format
    // archive by default.
    // It is also possible to create PAX -- POSIX 1003.1-2001 format
    // or USTAR -- POSIX 1003.1-1988 format.
    // Set the WriteFormat property to "gnu", "pax", or "ustar" to
    // choose the output TAR format:
    tar.WriteFormat = "gnu";

    // Add a directory tree to be included in the output TAR archive:
    var success = tar.AddDirRoot("/Users/chilkat/temp/abc123");
    if (success !== true) {
        console.log(tar.LastErrorText);
        return;
    }

    // Create the compressed TAR archive.
    // Note: You may use UNC paths, absolute, or relative paths.
    success = tar.WriteTarGz("/Users/chilkat/testData/tar/abc123.tgz");
    if (success !== true) {
        console.log(tar.LastErrorText);
        return;
    }

    console.log("Success.");

}

chilkatExample();