(Node.js) SFTP Synchronize Directory Tree - Download

Demonstrates how to download files to synchronize a local directory tree with a remote directory tree. The SyncTreeDownload method recursively descends the remote directory tree and downloads files based on existence, last-mod date/time and/or size differences.

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 requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var sftp = new chilkat.SFtp();

    var success = sftp.Connect("my-ssh-server.com",22);
    if (success == true) {
        success = sftp.AuthenticatePw("mySshLogin","mySshPassword");
    }

    if (success == true) {
        success = sftp.InitializeSftp();
    }

    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // Synchronize the remote directory tree rooted at "syncDownloadTest/xml"
    // with the local directory tree rooted at "qa_output"
    // Both directories are relative paths.  The remote directory
    // is relative to the HOME directory of the SSH user account.
    // The local directory is relative to the current working directory of the process.
    // It is also possible to use absolute paths.

    var remoteDir = "syncDownloadTest/xml";
    var localDir = "qa_output";

    // Possible modes that can be passed to the SyncTreeDownload method are:
    // mode=0: Download all files
    // mode=1: Download all files that do not exist on the local filesystem.
    // mode=2: Download newer or non-existant files.
    // mode=3: Download only newer files. If a file does not already exist on the local filesystem, it is not downloaded from the server.
    // mode=5: Download only missing files or files with size differences.
    // mode=6: Same as mode 5, but also download newer files.
    // mode=99: Do not download files, but instead delete remote files that do not exist locally.

    // This example will use mode 6 to download missing, newer, or files with size differences.
    var mode = 6;
    // This example will turn on recursion to synchronize the entire tree. 
    // Recursion can be turned off to synchronize the files of a single directory.
    var recursive = true;
    success = sftp.SyncTreeDownload(remoteDir,localDir,mode,recursive);
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    console.log("Success.");

}

chilkatExample();