Skip to content

Interface: CompactionSignalTriggerOptions<TSig> ​

Defined in: postgres/src/builders/compaction-config-builder.ts:10

Options for configuring a signal-correlated ledger compaction trigger via CompactionConfigBuilder.onSignal.

Maps an incoming signal payload to its target itemKey and specifies the grace period before raw wire frames are pruned.

Type Parameters ​

Type ParameterDefault typeDescription
TSigunknownSignal payload type.

Properties ​

PropertyModifierTypeDescriptionDefined in
afterGracePeriodHoursreadonlynumberNon-negative retention grace period in hours after signal arrival before pruning raw wire frames.postgres/src/builders/compaction-config-builder.ts:14
correlateByreadonly(sig) => stringPure function extracting the correlated itemKey from the signal payload.postgres/src/builders/compaction-config-builder.ts:12

Released under the MIT License.