Download a File from an SFTP Server

See more SFTP Examples

Demonstrates the Chilkat SFtp.DownloadFileByName method, which downloads a remote file to a local path in a single call. The first argument is the remote file path and the second is the local file path.

Note: This example uses relative local paths, which are resolved against the application's current working directory. Absolute local paths may also be used. Supply the paths appropriate to your own environment.

import { SFtp } from '@chilkat/react-native'

async function chilkatExample() {
  // Demonstrates the SFtp.DownloadFileByName method, which downloads a remote file to a local path
  // in one call.  The 1st argument is the remote file path and the 2nd is the local file path.

  const sftp = new SFtp();

  // Connect, authenticate, and initialize the SFTP subsystem.
  const port = 22;
  try {
    await sftp.connectAsync('sftp.example.com', port);
  } catch {
    console.log(sftp.lastErrorText);
    return;
  }

  // Normally you would not hard-code the password in source.  You should instead obtain it
  // from an interactive prompt, environment variable, or a secrets vault.
  const password = 'mySshPassword';

  try {
    await sftp.authenticatePwAsync('mySshLogin', password);
  } catch {
    console.log(sftp.lastErrorText);
    return;
  }

  try {
    await sftp.initializeSftpAsync();
  } catch {
    console.log(sftp.lastErrorText);
    return;
  }

  // Download a remote file to the local filesystem.
  try {
    await sftp.downloadFileByNameAsync('subdir/report.pdf', 'qa_output/report.pdf');
  } catch {
    console.log(sftp.lastErrorText);
    return;
  }

  console.log('Downloaded.');

  sftp.disconnect();
}