Class ServerProbeExperimental

Readonly Experimentalcapabilities

server

• get server(): {
      auth?: {
          keyPath?: string;
          method: "password"
          | "key"
          | "agent";
          savePassword: boolean;
      };
      host?: string;
      id: string;
      name: string;
      options: {
          allowInsecure?: boolean;
          allowRootDeletes?: boolean;
          hostKey?: { algorithm: string; pinnedAt: string; sha256: string };
          ipFamily?: 4 | 6;
          legacyAlgorithms?: boolean;
          passive: boolean;
          remoteDirMode?: string;
          remoteFileMode?: string;
          timeoutSeconds: number;
          tls?: {
              caFile?: string;
              minVersion: "TLSv1.2" | "TLSv1.3";
              servername?: string;
              trustedCertificate?: {
                  pinnedAt: string;
                  sha256: string;
                  validTo: string;
              };
          };
          uploadOnSave: boolean;
      };
      port?: number;
      protocol: "sftp"
      | "ftps"
      | "ftps-implicit"
      | "ftp"
      | "local";
      remoteRoot: string;
      username?: string;
      webUrl?: string;
  }
  Experimental

  The settings as connected: the ones given, with every change a decision made.

  Returns {
      auth?: {
          keyPath?: string;
          method: "password" | "key" | "agent";
          savePassword: boolean;
      };
      host?: string;
      id: string;
      name: string;
      options: {
          allowInsecure?: boolean;
          allowRootDeletes?: boolean;
          hostKey?: { algorithm: string; pinnedAt: string; sha256: string };
          ipFamily?: 4 | 6;
          legacyAlgorithms?: boolean;
          passive: boolean;
          remoteDirMode?: string;
          remoteFileMode?: string;
          timeoutSeconds: number;
          tls?: {
              caFile?: string;
              minVersion: "TLSv1.2" | "TLSv1.3";
              servername?: string;
              trustedCertificate?: {
                  pinnedAt: string;
                  sha256: string;
                  validTo: string;
              };
          };
          uploadOnSave: boolean;
      };
      port?: number;
      protocol: "sftp"
      | "ftps"
      | "ftps-implicit"
      | "ftp"
      | "local";
      remoteRoot: string;
      username?: string;
      webUrl?: string;
  }

startingFolder

• get startingFolder(): string | undefined
  Experimental

  The absolute folder the account opens in after signing in; absent for local.

  Returns string | undefined

close

• close(): Promise<void>
  Experimental

  Closes the connection. Safe to call more than once.

  Returns Promise<void>

exists

• exists(folder: string): Promise<boolean>
  Experimental

  True when an absolute folder exists and can be listed.

  Parameters

  • folder: string

  Returns Promise<boolean>

folders

• folders(folder: string): Promise<FolderListing>
  Experimental

  The folders and the number of files in an absolute folder.

  Parameters

  • folder: string

  Returns Promise<FolderListing>

Staticopen

• open(options: ServerProbeOptions): Promise<ServerProbe>
  Experimental

  Connects and signs in with options.server. Host key and certificate decisions are asked through options.host.

  Parameters

  • options: ServerProbeOptions

  Returns Promise<ServerProbe>

  Throws

  SyncError as a connection would: E_AUTH, E_TLS_CERT, E_HOST_KEY_MISMATCH, E_CONNECTION and others.