(Node.js) SFTP Read Text File

Demonstrates how to open a text file on the SSH server and read text.

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 sftp = new chilkat.SFtp();

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

    // Connect to the SSH server.  
    // The standard SSH port = 22
    // The hostname may be a hostname or IP address.
    var hostname = "sftp.example.com";
    var port = 22;
    var success = sftp.Connect(hostname,port);
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // Authenticate with the SSH server.  Chilkat SFTP supports
    // both password-based authenication as well as public-key
    // authentication.  This example uses password authenication.
    success = sftp.AuthenticatePw("myLogin","myPassword");
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // After authenticating, the SFTP subsystem must be initialized:
    success = sftp.InitializeSftp();
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // Open a file for reading.
    var handle;
    handle = sftp.OpenFile("myTest.txt","readOnly","openExisting");
    if (sftp.LastMethodSuccess !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // Assume the file we are reading contains the following text:
    // abcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ
    // (in ANSI format -- i.e. one byte per char).

    // Read 26 bytes:
    var sText;
    sText = sftp.ReadFileText(handle,26,"ansi");
    if (sftp.LastMethodSuccess !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // Should print "abcdefghijklmnopqrstuvwxyz"
    console.log(sText);

    // Read the next 10 bytes.
    sText = sftp.ReadFileText(handle,10,"ansi");
    if (sftp.LastMethodSuccess !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // Should print "1234567890"
    console.log(sText);

    // Read the next 26 bytes.
    sText = sftp.ReadFileText(handle,26,"ansi");
    if (sftp.LastMethodSuccess !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // Should print "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
    console.log(sText);

    // Close the file.
    success = sftp.CloseHandle(handle);
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    console.log("Success.");

}

chilkatExample();