Skip to content

Graphorin API reference v0.1.0


Graphorin API reference / @graphorin/server / / DeliveryCommentaryPolicy

Type Alias: DeliveryCommentaryPolicy

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

Defined in: packages/server/src/commentary/types.ts:33

Operator-facing policy. Identical semantics to the session-output sanitizer in @graphorin/sessions/commentary so the two layers are bytes-equal on idempotent re-application.

  • '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