TransferCheckpointStore
Defined in: src/transfers/TransferCheckpointStore.ts:140
Persistence contract for transfer checkpoints.
Implementations may be synchronous or asynchronous. clear is invoked when
a transfer completes successfully or a checkpoint is invalidated; it must
tolerate missing entries.
Methods
Section titled “Methods”clear()
Section titled “clear()”clear(key: TransferCheckpointKey): void | Promise<void>;Defined in: src/transfers/TransferCheckpointStore.ts:148
Removes the checkpoint for a transfer identity.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key | TransferCheckpointKey |
Returns
Section titled “Returns”void | Promise<void>
load()
Section titled “load()”load(key: TransferCheckpointKey): | TransferCheckpointRecord | Promise< | TransferCheckpointRecord | undefined> | undefined;Defined in: src/transfers/TransferCheckpointStore.ts:142
Loads the checkpoint for a transfer identity, or undefined when absent.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key | TransferCheckpointKey |
Returns
Section titled “Returns”| TransferCheckpointRecord
| Promise<
| TransferCheckpointRecord
| undefined>
| undefined
save()
Section titled “save()”save(key: TransferCheckpointKey, record: TransferCheckpointRecord): void | Promise<void>;Defined in: src/transfers/TransferCheckpointStore.ts:146
Persists the checkpoint for a transfer identity.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key | TransferCheckpointKey |
record | TransferCheckpointRecord |
Returns
Section titled “Returns”void | Promise<void>