@zero-transfer/ftp

Classic FTP provider with EPSV/PASV streaming and REST resume.

Install

npm install @zero-transfer/ftp

Overview

Plain FTP with EPSV/PASV streaming, REST-resume, MLST/MLSD listings, Unix LIST fallback, and full profile timeout enforcement. Use createFtpProviderFactory().

Usage

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

Public surface

This package publishes a narrowed surface of 14 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. | | FtpProviderOptions | Interface | See API reference. | | FtpPassiveHostStrategy | Type | See API reference. | | FtpResponse | Interface | See API reference. | | FtpResponseStatus | Type | See API reference. | | FtpFeatures | Interface | See API reference. | | FtpResponseParser | Class | See API reference. | | parseFtpFeatures | Function | See API reference. | | parseFtpResponseLines | Function | See API reference. | | parseMlsdLine | Function | See API reference. | | parseMlsdList | Function | See API reference. | | parseMlstTimestamp | Function | See API reference. | | parseUnixList | Function | See API reference. | | parseUnixListLine | Function | See API reference. |

Examples

| Example | What it shows | | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | | examples/ftp-basic.ts | Basic FTP upload + download example. | | examples/ftp-directory-ops.ts | FTP directory operations: list, stat, mkdir, rename, remove, rmdir. | | examples/transfer-queue.ts | Transfer queue with concurrency, progress, and per-job receipts. |

Documentation

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

License

MIT © Tony Wiedman