Skip to content

Interface: TopologyCommitOverlayBuilderInput<TOnSig, TDiscardSig> ​

Defined in: builders/topology-commit-overlay-builder-input.ts:13

Builder input options for P.topology(id).commitOverlayWhen(...), accepting MaybeBuilder<SignalNode> on signal triggers.

Configures signal-correlated commit and discard triggers for per-run copy-on-write topology contract overlays along with an optional maximum sealed age TTL.

Type Parameters ​

Type ParameterDefault typeDescription
TOnSigunknownCommit signal payload type.
TDiscardSigunknownDiscard signal payload type.

Properties ​

PropertyModifierTypeDescriptionDefined in
discardOnSignal?readonlyobjectOptional signal trigger that discards an unmerged run overlay.builders/topology-commit-overlay-builder-input.ts:21
discardOnSignal.correlateByreadonlyBivariantCallback<[sig: TDiscardSig], string>-builders/topology-commit-overlay-builder-input.ts:23
discardOnSignal.signalreadonlyMaybeBuilder<SignalNode<TDiscardSig>>-builders/topology-commit-overlay-builder-input.ts:22
maxSealedAgeHours?readonlynumberOptional TTL in hours after which unmerged sealed overlays are garbage-collected.builders/topology-commit-overlay-builder-input.ts:26
onSignal?readonlyobjectOptional signal trigger that commits the run's sealed overlay to the base store.builders/topology-commit-overlay-builder-input.ts:15
onSignal.baseBranch?readonlyBivariantCallback<[sig: TOnSig], string>-builders/topology-commit-overlay-builder-input.ts:18
onSignal.correlateByreadonlyBivariantCallback<[sig: TOnSig], string>-builders/topology-commit-overlay-builder-input.ts:17
onSignal.signalreadonlyMaybeBuilder<SignalNode<TOnSig>>-builders/topology-commit-overlay-builder-input.ts:16

Released under the MIT License.