Node.js

SFTP Read Directory Listing

See more SFTP Examples

Demonstrates how to download a directory listing and iterate over the files. Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

    //  This requires the Chilkat API to have been previously unlocked.
    //  See Global Unlock Sample for sample code.

    //  Important: It is helpful to send the contents of the
    //  sftp.LastErrorText property when requesting support.

    var sftp = new chilkat.SFtp();

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

    //  Connect to the SSH server.  
    //  The standard SSH port = 22
    //  The hostname may be a hostname or IP address.
    var hostname = "www.my-sftp-server.com";
    var port = 22;
    success = sftp.Connect(hostname,port);
    if (success == false) {
        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 == false) {
        console.log(sftp.LastErrorText);
        return;
    }

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

    //  Open a directory on the server...
    //  Paths starting with a slash are "absolute", and are relative 
    //  to the root of the file system. Names starting with any other 
    //  character are relative to the user's default directory (home directory).
    //  A path component of ".." refers to the parent directory, 
    //  and "." refers to the current directory. 
    var handle = sftp.OpenDir(".");
    if (sftp.LastMethodSuccess == false) {
        console.log(sftp.LastErrorText);
        return;
    }

    //  Download the directory listing:

    var dirListing = new chilkat.SFtpDir();
    success = sftp.ReadDirListing(handle,dirListing);
    if (success == false) {
        console.log(sftp.LastErrorText);
        return;
    }

    //  Close the handle for the directory listing.
    success = sftp.CloseHandle(handle);
    if (success == false) {
        console.log(sftp.LastErrorText);
        return;
    }

    //  Iterate over the files.
    var fileObj = new chilkat.SFtpFile();
    var i = 0;
    var n = dirListing.NumFilesAndDirs;
    while (i < n) {

        success = dirListing.FileAt(i,fileObj);
        if (success == false) {
            console.log(dirListing.LastErrorText);
            return;
        }

        console.log(fileObj.Filename);
        console.log(fileObj.FileType);
        console.log("Size in bytes: " + fileObj.Size32);
        console.log("----");

        i = i+1;
    }

    console.log("Success.");

}

chilkatExample();