Skip to content

TransferCheckpointHandle

Defined in: src/transfers/TransferCheckpointStore.ts:163

Live handle a provider uses to checkpoint part-aware progress during a write.

The transfer executor constructs the handle (binding the store, key, and source fingerprint) and attaches it to ProviderTransferWriteRequest.checkpoint. Providers that upload in discrete parts call save as the contiguous completed-part prefix advances and read state to pick up prior progress. Clearing on success is the executor’s responsibility - providers only ever record progress.

PropertyModifierTypeDescriptionDefined in
state?readonlyTransferCheckpointStateValidated state loaded for this transfer, when prior progress exists. undefined means start fresh (no checkpoint, or it was invalidated).src/transfers/TransferCheckpointStore.ts:168
clear(): Promise<void>;

Defined in: src/transfers/TransferCheckpointStore.ts:172

Removes the stored checkpoint (for example when the provider restarts the upload).

Promise<void>


save(state: TransferCheckpointState): Promise<void>;

Defined in: src/transfers/TransferCheckpointStore.ts:170

Persists new progress state for this transfer.

ParameterType
stateTransferCheckpointState

Promise<void>