(Node.js) SFTP Upload and Download to a StringBuilder Object

See more SFTP Examples

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() {

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

    // Set some timeouts, in milliseconds:
    sftp.ConnectTimeoutMs = 5000;
    sftp.IdleTimeoutMs = 10000;

    // Connect to the SSH server and then authenticate.
    var port = 22;
    success = sftp.Connect("MY-SSH-SERVER-DOMAIN-OR-IP",port);
    if (success == true) {
        success = sftp.AuthenticatePw("MY-SSH-LOGIN","MY-SSH-PASSWORD");
        if (success == true) {
            success = sftp.InitializeSftp();
        }

    }

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

    var sbA = new chilkat.StringBuilder();
    sbA.LoadFile("qa_data/hamlet.xml","utf-8");

    // Upload the contents of sbA to the SSH/SFTP server.
    var bIncludeBOM = false;
    var remotePath = "sftpTesting/hamlet.xml";
    success = sftp.UploadSb(sbA,remotePath,"utf-8",bIncludeBOM);
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // Download the file..
    var sbB = new chilkat.StringBuilder();
    success = sftp.DownloadSb(remotePath,"utf-8",sbB);
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // Verify that sbA and sbB have the exact same contents.
    console.log("size of sbA: " + sbA.Length);
    var bCaseSensitive = true;
    if (sbA.ContentsEqualSb(sbB,bCaseSensitive) == true) {
        console.log("Contents are equal. Success.");
    }
    else {
        console.log("Contents are NOT equal.  Failed.");
    }

    sftp.Disconnect();

}

chilkatExample();