@zero-transfer/classic

FTP, FTPS, and SFTP providers in one install.

Install

npm install @zero-transfer/classic

Overview

Bundle of the three classic providers: FTP, FTPS, and SFTP. Wire createFtpProviderFactory(), createFtpsProviderFactory(), and createSftpProviderFactory() into a single TransferClient to talk to traditional file servers. Zero runtime dependencies - SFTP is implemented on top of the first-party native SSH stack.

Usage

import {
  createTransferClient,
  uploadFile,
  downloadFile,
  createFtpProviderFactory,
} from "@zero-transfer/classic";

Public surface

This package publishes a narrowed surface of 6 exports. These symbols are also available from @zero-transfer/sdk; the table below links into the full API reference:

| Symbol | Kind | Notes | | --------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------------------ | | createFtpProviderFactory | Function | See API reference. | | createFtpsProviderFactory | Function | See API reference. | | createSftpProviderFactory | Function | See API reference. | | FtpProviderOptions | Interface | See API reference. | | FtpsProviderOptions | Interface | See API reference. | | SftpProviderOptions | Interface | See API reference. |

Examples

| Example | What it shows | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | | examples/sftp-private-key.ts | SFTP private-key authentication example with host-key pinning. | | examples/sftp-directory-ops.ts | SFTP directory operations: list, stat, mkdir, rename, remove, rmdir. | | examples/ftps-client-certificate.ts | FTPS client-certificate (mutual TLS) example with certificate pinning. | | examples/ftps-directory-ops.ts | FTPS directory operations: list, stat, mkdir, rename, remove, rmdir. | | examples/ftp-directory-ops.ts | FTP directory operations: list, stat, mkdir, rename, remove, rmdir. |

Documentation

• Scope page
• Top-level README
• Full API reference
• Capability matrix
• Examples

License

MIT © Tony Wiedman