Skip to content

Graphorin API reference v0.8.0


Graphorin API reference / @graphorin/channels / / OutboundCommentaryPolicy

Type Alias: OutboundCommentaryPolicy

ts
type OutboundCommentaryPolicy = "wrap" | "strip" | "pass-through";

Defined in: packages/tools/dist/outbound/commentary-patterns.d.ts

Operator-facing policy shared by all outbound commentary sanitizers.

  • 'wrap' (default) - wraps the matched fragment in a <<<commentary>>>...<<</commentary>>> envelope so downstream consumers can choose to render or hide based on context.
  • 'strip' - removes the matched fragment entirely.
  • 'pass-through' - disables the sanitization (operator opt-in for trusted deployments).

Stable