Skip to content
1 min read · 235 words

Interface: OrderingGuardOptions

Defined in: src/batteries/validation/types.ts:207

Configuration for an ordering guard middleware.

Properties

PropertyTypeDescriptionDefined in
action?"enforce" | "mutate"enforce validates without mutation; mutate applies safe repairs before re-evaluation.src/batteries/validation/types.ts:213
allowMetadataFallbackRepair?booleanStronger, separate opt-in for vendor metadata fabrication. action: 'mutate' alone never fills missing metadata: unlike reordering or an empty filler, this can make a provenance claim. Both this flag and mutate action must be enabled for fallback repair to run.src/batteries/validation/types.ts:223
disableAdvisoryRuleIds?string[]Advisory rule ids to skip entirely; this cannot suppress any blocking rule.src/batteries/validation/types.ts:227
mode?"union-of-rules" | "each" | "first-match"Profile composition strategy; defaults to union-of-rules.src/batteries/validation/types.ts:211
onRepair?"log" | "silent"Whether applied repairs are logged or kept silent; defaults to log.src/batteries/validation/types.ts:217
onViolation?"nack" | "throw"Whether remaining blocking violations are nacked or thrown; defaults to nack.src/batteries/validation/types.ts:215
profiles(string | OrderingProfile)[]Profiles to resolve and evaluate, by registry name or consumer-authored profile object.src/batteries/validation/types.ts:209
snapshotStashKey?stringStash key used for the stateful preservation snapshot.src/batteries/validation/types.ts:225