TransferResumeOptions

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

Checkpoint/resume configuration consumed by createProviderTransferExecutor (directly or through runRoute / client defaults).

Example

import {
  createFileSystemTransferCheckpointStore,
  createProviderTransferExecutor,
} from "@zero-transfer/sdk";

const executor = createProviderTransferExecutor({
  resolveSession,
  resume: {
    store: createFileSystemTransferCheckpointStore({ directory: "./.zt-checkpoints" }),
  },
});

Properties

Property	Type	Description	Defined in
mode?	TransferResumeMode	Resume behavior. Defaults to "auto".	src/transfers/createProviderTransferExecutor.ts:93
persistIntervalBytes?	number	Minimum bytes of new committed progress between byte-offset checkpoint persists. Defaults to 8 MiB. Part-aware providers persist per committed part instead and ignore this value.	src/transfers/createProviderTransferExecutor.ts:99
scope?	string	Optional namespace mixed into checkpoint keys. Checkpoints are keyed by source+destination provider/path; set a scope (for example the host or profile id) when identical provider/path pairs can refer to different servers.	src/transfers/createProviderTransferExecutor.ts:106
store	TransferCheckpointStore	Checkpoint persistence backend.	src/transfers/createProviderTransferExecutor.ts:91