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

See more SFTP Examples

Demonstrates how to SFTP upload from a BinData object, and download into a BinData object.

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;

    // 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 bdA = new chilkat.BinData();
    bdA.LoadFile("qa_data/jpg/penguins.jpg");

    // Upload the contents of bdA to the SSH/SFTP server.
    var remotePath = "sftpTesting/penguins.jpg";
    success = sftp.UploadBd(bdA,remotePath);
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // Download the file..
    var bdB = new chilkat.BinData();
    success = sftp.DownloadBd(remotePath,bdB);
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // Verify that bdA and bdB have the exact same contents.
    console.log("size of bdA: " + bdA.NumBytes);
    if (bdA.ContentsEqual(bdB) == true) {
        console.log("Contents are equal. Success.");
    }
    else {
        console.log("Contents are NOT equal.  Failed.");
    }

    sftp.Disconnect();

}

chilkatExample();