(Node.js) SFTP Sync Download Tree w/ Must-Match Directory Constraints

Demonstrates how SFTP synchronize a directory tree in the download direction, but only entering directories matching a set of wildcard filenames.

Note: This example requires Chilkat v9.5.0.76 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, 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() {

    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;
    }

    // Possible synchronization modes 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.

    // Only enter remote directories named either "data" or matching "x*"
    sftp.SyncMustMatchDir = "data; x*";

    // Imagine our remote directory tree has these files and directories:

    // 	accentedLatin1.txt
    // 	accentedUtf8.txt
    // 	alice.key
    // 	anter_cert.pem
    // 	chiliPepper.gif
    // 	helloWorld.pdf
    // 	abc/chiliPepper.gif
    // 	abc/ghk/
    // 	data/chiliPepper.gif
    // 	data/xyz/dkimHtmlBody.txt
    // 	data/xyz/dkimVerifyTest.eml
    // 	data/xyz/emailForCreateDsn.eml
    // 	text/frenchUtf8.txt
    // 	text/helloWorld.txt
    // 	text/PolishEmailBody.txt
    // 	text/something/

    var remoteDir = "syncDownloadTest/someDir";
    var localDir = "qa_output";
    var mode = 0;
    var recursive = true;
    success = sftp.SyncTreeDownload(remoteDir,localDir,mode,recursive);
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // The following files were downloaded:

    // accentedLatin1.txt
    // accentedUtf8.txt
    // alice.key
    // anter_cert.pem
    // chiliPepper.gif
    // helloWorld.pdf
    // data/chiliPepper.gif
    // data/xyz/dkimHtmlBody.txt
    // data/xyz/dkimVerifyTest.eml
    // data/xyz/emailForCreateDsn.eml

    console.log("Success.");

}

chilkatExample();