TransferClientDefaults

Defined in: src/core/TransferClient.ts:60

Client-level execution defaults applied when a call site does not supply its own value.

Defaults are consumed by runRoute, the one-shot helpers (uploadFile, downloadFile, copyBetween), TransferQueue (via its client option), and scheduled routes fired through MftScheduler. The TransferEngine primitive stays fully explicit: defaults never reach engine.execute() directly.

Per-call options always win over client defaults.

Additional default slots (verify, compression, policy) land here as their features ship in later releases; the shape is additive.

Example

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

const client = createTransferClient({
  providers: [createSftpProviderFactory(), createS3ProviderFactory()],
  defaults: {
    retry: createDefaultRetryPolicy(),
    timeout: { stallTimeoutMs: 30_000 },
    resume: {
      store: createFileSystemTransferCheckpointStore({ directory: "./.zt-checkpoints" }),
    },
  },
});

Properties

Property	Type	Description	Defined in
resume?	TransferResumeOptions	Default checkpoint/resume configuration for transfers executed through this client.	src/core/TransferClient.ts:66
retry?	TransferRetryPolicy	Default retry policy for transfers executed through this client.	src/core/TransferClient.ts:62
timeout?	TransferTimeoutPolicy	Default timeout policy for transfers executed through this client.	src/core/TransferClient.ts:64