TransferBatchStateStore
Defined in: src/transfers/resumableBatch.ts:142
Persistence contract for batch progress. clear is invoked when every
executable step has completed; it must tolerate missing entries.
Methods
Section titled “Methods”clear()
Section titled “clear()”clear(planId: string): void | Promise<void>;Defined in: src/transfers/resumableBatch.ts:148
Removes progress for a plan id.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
planId | string |
Returns
Section titled “Returns”void | Promise<void>
load()
Section titled “load()”load(planId: string): | TransferBatchState | Promise< | TransferBatchState | undefined> | undefined;Defined in: src/transfers/resumableBatch.ts:144
Loads progress for a plan id, or undefined when absent.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
planId | string |
Returns
Section titled “Returns”| TransferBatchState
| Promise<
| TransferBatchState
| undefined>
| undefined
save()
Section titled “save()”save(state: TransferBatchState): void | Promise<void>;Defined in: src/transfers/resumableBatch.ts:146
Persists progress for a plan id.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
state | TransferBatchState |
Returns
Section titled “Returns”void | Promise<void>