createFtpProviderFactory

function createFtpProviderFactory(options?: FtpProviderOptions): ProviderFactory;

Defined in: src/providers/classic/ftp/FtpProvider.ts:187

Creates a provider factory for classic FTP connections.

Parameters

Parameter	Type	Description
options	FtpProviderOptions	Optional provider defaults.

Returns

ProviderFactory

Provider factory suitable for createTransferClient({ providers: [...] }).

Example

import { createFtpProviderFactory, createTransferClient } from "@zero-transfer/sdk";

const client = createTransferClient({ providers: [createFtpProviderFactory()] });

const session = await client.connect({
  host: "ftp.example.com",
  provider: "ftp",
  username: "deploy",
  password: { env: "FTP_PASSWORD" },
});