(Node.js) FTP Bandwidth Throttle for Downloads

Demonstrates the Chilkat FTP2 download bandwidth throttling property : BandwidthThrottleDown.

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

    // To use FTP bandwidth throttling, set the BandwidthThrottleDown
    // property to a maximum desired bytes/second:
    // This example limits the download to 50K per second.
    ftp.BandwidthThrottleDown = 50000;

    // The default data transfer mode is "Active" as opposed to "Passive".

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

    // Change to the remote directory where the file is located.
    // This step is only necessary if the file is not in the root directory
    // for the FTP account.
    success = ftp.ChangeRemoteDir("junk");
    if (success !== true) {
        console.log(ftp.LastErrorText);
        return;
    }

    // Download a file.
    var localFilename = "hamlet.xml";
    var remoteFilename = "hamlet.xml";

    success = ftp.GetFile(remoteFilename,localFilename);
    if (success !== true) {
        console.log(ftp.LastErrorText);
        return;
    }

    success = ftp.Disconnect();

    console.log("File Downloaded!");

}

chilkatExample();