DownloadFileOptions
Defined in: src/client/operations.ts:96
Options for downloadFile.
Extends
Section titled “Extends”Properties
Section titled “Properties”| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
bandwidthLimit? | TransferBandwidthLimit | Optional bandwidth limit forwarded to the engine. | RunRouteOptions.bandwidthLimit | src/mft/runRoute.ts:55 |
client | TransferClient | Transfer client used to resolve both endpoint providers. | - | src/client/operations.ts:98 |
engine? | TransferEngine | Optional transfer engine override. A fresh engine is created when omitted. | RunRouteOptions.engine | src/mft/runRoute.ts:41 |
jobId? | string | Optional explicit job id. Defaults to a deterministic route-derived id. | RunRouteOptions.jobId | src/mft/runRoute.ts:43 |
localPath | string | Local destination path. Relative paths are resolved against process.cwd(). | - | src/client/operations.ts:102 |
metadata? | Record<string, unknown> | Caller-defined metadata merged into the resulting transfer job. | RunRouteOptions.metadata | src/mft/runRoute.ts:59 |
now? | () => Date | Optional clock used to derive the default job id. Defaults to Date.now. | RunRouteOptions.now | src/mft/runRoute.ts:45 |
onProgress? | (event: TransferProgressEvent) => void | Progress observer forwarded to the engine. | RunRouteOptions.onProgress | src/mft/runRoute.ts:51 |
resume? | TransferResumeOptions | Checkpoint/resume configuration forwarded to the executor. Falls back to client.defaults.resume. | RunRouteOptions.resume | src/mft/runRoute.ts:57 |
retry? | TransferRetryPolicy | Retry policy forwarded to the engine. Falls back to client.defaults.retry. | RunRouteOptions.retry | src/mft/runRoute.ts:49 |
routeId? | string | Stable route id assigned to the synthetic route. Defaults to "upload:...", "download:...", or "copy:...". | FriendlyTransferOptions.routeId | src/client/operations.ts:30 |
routeName? | string | Optional human-readable route name forwarded to telemetry. | FriendlyTransferOptions.routeName | src/client/operations.ts:32 |
signal? | AbortSignal | Abort signal used to cancel the route execution. | RunRouteOptions.signal | src/mft/runRoute.ts:47 |
source | RemoteFileEndpoint | Remote source endpoint. | - | src/client/operations.ts:100 |
timeout? | TransferTimeoutPolicy | Timeout policy forwarded to the engine. Falls back to client.defaults.timeout. | RunRouteOptions.timeout | src/mft/runRoute.ts:53 |