Skip to content

Graphorin API reference v0.1.0


Graphorin API reference / @graphorin/observability / redaction/imperative-patterns / ScanResult

Interface: ScanResult

Defined in: packages/observability/src/redaction/imperative-patterns.ts:173

Compiled scan helper. Returns the list of pattern names that fired AND the number of bytes the strip would remove if applied. Bounded by the budget hint — when exceeded, returns null to let the caller apply the best-effort 'detect-failed' annotation.

Stable

Properties

PropertyModifierTypeDefined in
bytesMatchedreadonlynumberpackages/observability/src/redaction/imperative-patterns.ts:175
hitsreadonlyreadonly { matchCount: number; pattern: string; }[]packages/observability/src/redaction/imperative-patterns.ts:174
scanDurationUsreadonlynumberpackages/observability/src/redaction/imperative-patterns.ts:176