ProviderTransferWriteRequest
Defined in: src/providers/ProviderTransferOperations.ts:60
Request passed to provider write implementations.
Extends
Section titled “Extends”Properties
Section titled “Properties”| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
attempt | number | One-based attempt number. | ProviderTransferRequest.attempt | src/transfers/TransferEngine.ts:30 |
bandwidthLimit? | TransferBandwidthLimit | Optional throughput limit shape for concrete executors to honor. | ProviderTransferRequest.bandwidthLimit | src/transfers/TransferEngine.ts:34 |
checkpoint? | TransferCheckpointHandle | Checkpoint handle for part-aware providers (multipart/staged-block uploads). Attached by the transfer executor when resume is configured; providers persist progress through it and read prior state from it. | - | src/providers/ProviderTransferOperations.ts:74 |
content | TransferDataSource | Content stream to write to the provider endpoint. | - | src/providers/ProviderTransferOperations.ts:62 |
endpoint | TransferEndpoint | Endpoint owned by the provider handling this request. | ProviderTransferRequest.endpoint | src/providers/ProviderTransferOperations.ts:34 |
job | TransferJob | Job being executed. | ProviderTransferRequest.job | src/transfers/TransferEngine.ts:28 |
offset? | number | Resume offset for partial writes when supported by the provider. | - | src/providers/ProviderTransferOperations.ts:66 |
onBytesCommitted? | (committedBytes: number) => void | Reports the absolute contiguous byte watermark durably acknowledged by the destination (including any resume offset). Sequential-append providers call this after each acknowledged write so the executor can persist byte-offset checkpoints; unlike reportProgress the value must never include unacknowledged in-flight bytes. | - | src/providers/ProviderTransferOperations.ts:82 |
signal? | AbortSignal | Abort signal active for this execution when supplied. | ProviderTransferRequest.signal | src/transfers/TransferEngine.ts:32 |
totalBytes? | number | Expected total bytes for the content stream when known. | - | src/providers/ProviderTransferOperations.ts:64 |
verification? | TransferVerificationResult | Verification details from the read side that a writer may preserve or compare. | - | src/providers/ProviderTransferOperations.ts:68 |
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”Inherited from
Section titled “Inherited from”ProviderTransferRequest.reportProgress
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