RunRouteOptions
Defined in: src/mft/runRoute.ts:32
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:52 |
client | TransferClient | Transfer client whose registry can resolve both endpoint providers. | src/mft/runRoute.ts:34 |
engine? | TransferEngine | Optional transfer engine override. A fresh engine is created when omitted. | src/mft/runRoute.ts:38 |
jobId? | string | Optional explicit job id. Defaults to a deterministic route-derived id. | src/mft/runRoute.ts:40 |
metadata? | Record<string, unknown> | Caller-defined metadata merged into the resulting transfer job. | src/mft/runRoute.ts:54 |
now? | () => Date | Optional clock used to derive the default job id. Defaults to Date.now. | src/mft/runRoute.ts:42 |
onProgress? | (event: TransferProgressEvent) => void | Progress observer forwarded to the engine. | src/mft/runRoute.ts:48 |
retry? | TransferRetryPolicy | Retry policy forwarded to the engine. | src/mft/runRoute.ts:46 |
route | MftRoute | Route to execute. | src/mft/runRoute.ts:36 |
signal? | AbortSignal | Abort signal used to cancel the route execution. | src/mft/runRoute.ts:44 |
timeout? | TransferTimeoutPolicy | Timeout policy forwarded to the engine. | src/mft/runRoute.ts:50 |