TransferEngineExecuteOptions
Defined in: src/transfers/TransferEngine.ts:67
Options used by TransferEngine.execute.
Properties
Section titled “Properties”| Property | Type | Description | Defined in |
|---|---|---|---|
bandwidthLimit? | TransferBandwidthLimit | Optional throughput limit shape passed through to concrete executors. | src/transfers/TransferEngine.ts:77 |
retry? | TransferRetryPolicy | Retry policy used for failed attempts. | src/transfers/TransferEngine.ts:71 |
signal? | AbortSignal | Abort signal used to cancel the job. | src/transfers/TransferEngine.ts:69 |
timeout? | TransferTimeoutPolicy | Timeout policy enforced by the engine. | src/transfers/TransferEngine.ts:75 |
Methods
Section titled “Methods”onProgress()?
Section titled “onProgress()?”optional onProgress(event: TransferProgressEvent): void;Defined in: src/transfers/TransferEngine.ts:73
Progress observer for normalized transfer progress events.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
event | TransferProgressEvent |
Returns
Section titled “Returns”void