React Native

SFTP Read Text File to String

See more SFTP Examples

Demonstrates how to download a text file from an SSH server directly into a string variable. React Native

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

async function chilkatExample() {
  // This example assumes the Chilkat API to have been previously unlocked.
  // See Global Unlock Sample for sample code.

  const sftp = new 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.
  const hostname = 'sftp.example.com';
  const port = 22;
  try {
    await sftp.connectAsync(hostname, port);
  } catch {
    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.
  try {
    await sftp.authenticatePwAsync('myLogin', 'myPassword');
  } catch {
    console.log(sftp.lastErrorText);
    return;
  }

  // After authenticating, the SFTP subsystem must be initialized:
  try {
    await sftp.initializeSftpAsync();
  } catch {
    console.log(sftp.lastErrorText);
    return;
  }

  // Open a file on the server:
  let handle = '';
  try {
    handle = await sftp.openFileAsync('hamlet.xml', 'readOnly', 'openExisting');
  } catch {
    console.log(sftp.lastErrorText);
    return;
  }

  // Get the total size of this file (in bytes)
  const bFollowLinks = false;
  const bIsHandle = true;

  // bFollowLinks is ignored because we are passing a handle
  // and not a remote filename.
  // There are alternative methods for handling file sizes
  // greater than 32-bit.  (See the reference documentation.)
  const numBytes = await sftp.getFileSize32Async(handle, bFollowLinks, bIsHandle);
  if (numBytes < 0) {
    console.log(sftp.lastErrorText);
    return;
  }

  // The charset indicates the character encoding of the text
  // file on the SSH server.   Setting the charset correctly
  // allows the Chilkat SFTP component to correctly interpret
  // the bytes that represent the characters.
  const charset = 'ansi';
  let fileContents = '';
  try {
    fileContents = await sftp.readFileTextAsync(handle, numBytes, charset);
    console.log('Received file:');
    console.log(fileContents);
  } catch {
    console.log(sftp.lastErrorText);
    return;
  }

  // Close the file.
  try {
    await sftp.closeHandleAsync(handle);
  } catch {
    console.log(sftp.lastErrorText);
    return;
  }

  console.log('Success.');
}