createLocalProviderFactory

function createLocalProviderFactory(options?: LocalProviderOptions): ProviderFactory;

Defined in: src/providers/local/LocalProvider.ts:101

Creates a provider factory backed by the local filesystem.

Useful for copying files between two remote endpoints via a local staging area, or as the destination for downloadFile. The friendly uploadFile helper registers a local provider implicitly.

Parameters

Parameter	Type	Description
options	LocalProviderOptions	Optional local root path exposed through provider sessions.

Returns

ProviderFactory

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

Example

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

const client = createTransferClient({
  providers: [createLocalProviderFactory({ rootPath: "/var/lib/zt-staging" })],
});

const session = await client.connect({ host: "staging", provider: "local" });
const list = await session.fs.list("/");