Skip to content

createProviderTransferExecutor

function createProviderTransferExecutor(options: ProviderTransferExecutorOptions): TransferExecutor;

Defined in: src/transfers/createProviderTransferExecutor.ts:142

Creates a TransferExecutor that reads from a source provider and writes to a destination provider.

The returned executor supports single-object upload, download, and copy jobs. Provider sessions must expose session.transfers.read() and session.transfers.write(); concrete providers remain responsible for the actual streaming implementation.

When ProviderTransferExecutorOptions.resume is configured the executor checkpoints progress against the supplied store and resumes interrupted transfers: the source is fingerprinted (size/mtime/etag) and a stored checkpoint is honored only when the fingerprint still matches and the destination passes a size sanity check. Engine retries resume in-process for free, and a fresh process resumes through the same store. Checkpoints are cleared on success and invalidated checkpoints trigger best-effort provider-side cleanup via ProviderTransferOperations.discardResumable.

ParameterTypeDescription
optionsProviderTransferExecutorOptionsSession resolver plus optional throttle and resume configuration.

TransferExecutor

Transfer executor suitable for TransferEngine.execute or TransferQueue.