(Node.js) Get FTP Directory Listing Information

Node.js example showing how to get information about files and subdirectories in the current remote FTP directory.

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 ftp = new chilkat.Ftp2();

    ftp.Hostname = "ftp.example.com";
    ftp.Username = "login";
    ftp.Password = "password";

    // Connect and login to the FTP server.
    var success = ftp.Connect();
    if (success !== true) {
        console.log(ftp.LastErrorText);
        return;
    }

    // The ListPattern property is our directory listing filter.
    // The default value is "*", which includes everything.
    console.log(ftp.ListPattern);

    // To get file and sub-directory information, simply
    // loop from 0 to ftp.GetDirCount() - 1
    var i;
    var n;
    n = ftp.GetDirCount();
    if (n < 0) {
        console.log(ftp.LastErrorText);
        return;
    }

    if (n > 0) {
        for (i = 0; i <= n - 1; i++) {

            // Display the filename
            console.log(ftp.GetFilename(i));

            // Display the file size (in bytes)
            console.log(ftp.GetSize(i));

            // Is this a sub-directory?
            if (ftp.GetIsDirectory(i) == true) {
                console.log(".. this is a sub-directory");
            }

            console.log("--");
        }

    }

    console.log("-----------------------------------");

    // Only files and directories
    // matching the ListPattern are returned.
    ftp.ListPattern = "*.asp";
    n = ftp.GetDirCount();
    if (n < 0) {
        console.log(ftp.LastErrorText);
        return;
    }

    if (n > 0) {
        for (i = 0; i <= n - 1; i++) {

            // Display the filename
            console.log(ftp.GetFilename(i));

            // Display the file size (in bytes)
            console.log(ftp.GetSize(i));

            console.log("--");
        }

    }

    success = ftp.Disconnect();

}

chilkatExample();