RunRouteOptions
Defined in: src/mft/runRoute.ts:35
Options accepted by runRoute.
Properties
Section titled “Properties”| Property | Type | Description | Defined in |
|---|---|---|---|
bandwidthLimit? | TransferBandwidthLimit | Optional bandwidth limit forwarded to the engine. | src/mft/runRoute.ts:55 |
client | TransferClient | Transfer client whose registry can resolve both endpoint providers. | src/mft/runRoute.ts:37 |
engine? | TransferEngine | Optional transfer engine override. A fresh engine is created when omitted. | src/mft/runRoute.ts:41 |
jobId? | string | Optional explicit job id. Defaults to a deterministic route-derived id. | src/mft/runRoute.ts:43 |
metadata? | Record<string, unknown> | Caller-defined metadata merged into the resulting transfer job. | src/mft/runRoute.ts:59 |
now? | () => Date | Optional clock used to derive the default job id. Defaults to Date.now. | src/mft/runRoute.ts:45 |
onProgress? | (event: TransferProgressEvent) => void | Progress observer forwarded to the engine. | src/mft/runRoute.ts:51 |
resume? | TransferResumeOptions | Checkpoint/resume configuration forwarded to the executor. Falls back to client.defaults.resume. | src/mft/runRoute.ts:57 |
retry? | TransferRetryPolicy | Retry policy forwarded to the engine. Falls back to client.defaults.retry. | src/mft/runRoute.ts:49 |
route | MftRoute | Route to execute. | src/mft/runRoute.ts:39 |
signal? | AbortSignal | Abort signal used to cancel the route execution. | src/mft/runRoute.ts:47 |
timeout? | TransferTimeoutPolicy | Timeout policy forwarded to the engine. Falls back to client.defaults.timeout. | src/mft/runRoute.ts:53 |