Interface: PayloadSpill
Defined in: packages/workflow-engine/src/kernel/spill.ts:124
Properties
thresholdBytes
readonlythresholdBytes:number
Defined in: packages/workflow-engine/src/kernel/spill.ts:126
Threshold in effect, for diagnostics.
Methods
deleteUnder()
deleteUnder(
prefix,keep?):Promise<void>
Defined in: packages/workflow-engine/src/kernel/spill.ts:141
Best-effort delete of every spilled value under a key prefix, except
any key listed in keep. The exception exists for a partial ledger
clear, which must leave the results of the rows it preserves readable.
Parameters
prefix
string
keep?
Iterable<string, any, any>
Returns
Promise<void>
pack()
pack(
key,value):Promise<unknown>
Defined in: packages/workflow-engine/src/kernel/spill.ts:133
Store value under key and return a SpillRef when it exceeds the
threshold; return value untouched otherwise. Values that are not
JSON-serialisable are returned untouched — the ledger's own
serialisation contract, not this one, decides what happens to them.
Parameters
key
string
value
unknown
Returns
Promise<unknown>
unpack()
unpack(
value):Promise<unknown>
Defined in: packages/workflow-engine/src/kernel/spill.ts:135
Resolve a SpillRef back to its value; pass anything else through.
Parameters
value
unknown
Returns
Promise<unknown>