DownloadFileOptions

Defined in: src/client/operations.ts:96

Options for downloadFile.

Extends

• FriendlyTransferOptions

Properties

Property	Type	Description	Inherited from	Defined in
bandwidthLimit?	TransferBandwidthLimit	Optional bandwidth limit forwarded to the engine.	RunRouteOptions.bandwidthLimit	src/mft/runRoute.ts:52
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:38
jobId?	string	Optional explicit job id. Defaults to a deterministic route-derived id.	RunRouteOptions.jobId	src/mft/runRoute.ts:40
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:54
now?	() => Date	Optional clock used to derive the default job id. Defaults to Date.now.	RunRouteOptions.now	src/mft/runRoute.ts:42
onProgress?	(event: TransferProgressEvent) => void	Progress observer forwarded to the engine.	RunRouteOptions.onProgress	src/mft/runRoute.ts:48
retry?	TransferRetryPolicy	Retry policy forwarded to the engine.	RunRouteOptions.retry	src/mft/runRoute.ts:46
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:44
source	RemoteFileEndpoint	Remote source endpoint.	-	src/client/operations.ts:100
timeout?	TransferTimeoutPolicy	Timeout policy forwarded to the engine.	RunRouteOptions.timeout	src/mft/runRoute.ts:50