Graphorin API reference v0.15.1
Graphorin API reference / @graphorin/channels / / SanitizationOutcome
Interface: SanitizationOutcome
Defined in: packages/tools/dist/inbound/sanitize.d.ts
Stable
Outcome of applyInboundSanitization.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
blocked | readonly | boolean | Set when failClosed: true and at least one pattern fired. The executor surfaces this as ToolError({ kind: 'inbound_sanitization_blocked' }). | packages/tools/dist/inbound/sanitize.d.ts |
body | readonly | string | Final body that flows downstream. | packages/tools/dist/inbound/sanitize.d.ts |
bytesStripped | readonly | number | Net bytes removed by the strip pass (always >= 0). Redaction replaces each match with a mask, so this is max(0, before - after) - it is 0 when the masks are at least as long as the text they covered even though matches were stripped (see stripped / patternsHit). | packages/tools/dist/inbound/sanitize.d.ts |
modified | readonly | boolean | Whether the body was modified relative to the input. | packages/tools/dist/inbound/sanitize.d.ts |
patternsHit | readonly | readonly string[] | Pattern names that fired during the scan. | packages/tools/dist/inbound/sanitize.d.ts |
scanDurationUs | readonly | number | Time spent on the scan in microseconds. | packages/tools/dist/inbound/sanitize.d.ts |
scanTimedOut | readonly | boolean | Whether the scan timed out (best-effort fallthrough). | packages/tools/dist/inbound/sanitize.d.ts |
stripped | readonly | boolean | Whether matches were stripped. | packages/tools/dist/inbound/sanitize.d.ts |
wrapped | readonly | boolean | Whether the body is wrapped in the untrusted-content envelope. | packages/tools/dist/inbound/sanitize.d.ts |