TransferExecutionContext
Defined in: src/transfers/TransferEngine.ts:26
Context passed to a concrete transfer operation.
Extended by
Section titled “Extended by”Properties
Section titled “Properties”| Property | Type | Description | Defined in |
|---|---|---|---|
attempt | number | One-based attempt number. | src/transfers/TransferEngine.ts:30 |
bandwidthLimit? | TransferBandwidthLimit | Optional throughput limit shape for concrete executors to honor. | src/transfers/TransferEngine.ts:34 |
job | TransferJob | Job being executed. | src/transfers/TransferEngine.ts:28 |
signal? | AbortSignal | Abort signal active for this execution when supplied. | src/transfers/TransferEngine.ts:32 |
Methods
Section titled “Methods”reportProgress()
Section titled “reportProgress()”reportProgress(bytesTransferred: number, totalBytes?: number): TransferProgressEvent;Defined in: src/transfers/TransferEngine.ts:38
Emits a normalized progress event through engine options.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
bytesTransferred | number |
totalBytes? | number |
Returns
Section titled “Returns”throwIfAborted()
Section titled “throwIfAborted()”throwIfAborted(): void;Defined in: src/transfers/TransferEngine.ts:36
Throws an SDK abort error when the active signal has been cancelled.
Returns
Section titled “Returns”void