React Native

Create an FTP Upload Plan

Demonstrates the Chilkat Ftp2.CreatePlan method, which creates and returns a textual upload plan for a local directory. The only argument is the local directory. The object must be connected, because the plan records the current absolute remote directory together with the local source paths.

Note: The local paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background: A plan is a saved, resumable description of an upload — the list of local files and their absolute remote destinations — computed once and executed later (or on another run) with PutPlan. Separating planning from execution suits large or unreliable transfers: the plan can be reviewed, stored, and re-run, and because it records absolute remote paths it stays correct even if the working directory later changes.

Chilkat React Native Downloads

Download Chilkat for React Native

React Native

import { Ftp2, StringBuilder } from '@chilkat/react-native'

async function chilkatExample() {
  // Demonstrates the Ftp2.CreatePlan method, which creates and returns a textual upload plan for a
  // local directory.  The only argument is the local directory.  The object must be connected,
  // because the plan records the current absolute remote directory.

  const ftp = new Ftp2();

  ftp.hostname = 'ftp.example.com';
  ftp.username = 'myFtpLogin';

  // 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.
  ftp.password = 'myPassword';

  try {
    await ftp.connectAsync();
  } catch {
    console.log(ftp.lastErrorText);
    return;
  }

  try {
    await ftp.changeRemoteDirAsync('public_html');
  } catch {
    console.log(ftp.lastErrorText);
    return;
  }

  // The plan captures which local files to upload and the absolute remote destination.  Save it so
  // the upload can be run (or resumed) later with PutPlan.
  let plan: string;
  try {
    plan = await ftp.createPlanAsync('qa_data/site');
  } catch {
    console.log(ftp.lastErrorText);
    return;
  }

  // Persist the plan text for later use.
  const sbPlan = new StringBuilder();
  sbPlan.append(plan);
  try {
    sbPlan.writeFile('qa_output/upload_plan.txt', 'utf-8', false);
  } catch {
    console.log(sbPlan.lastErrorText);
    return;
  }

  console.log('Upload plan created.');

  try {
    await ftp.disconnectAsync();
  } catch {
    console.log(ftp.lastErrorText);
    return;
  }
}