Skip to content
Generated from the .d.ts files published in guardlink@2.7.1. Report problems against guardlink, not this page.

report

Everything exported by guardlink/report, from the .d.ts files published in guardlink@2.7.1. See the entry points for the other subpaths, and use guardlink as a library for worked examples.

emitAgentReach(model, lines, headingSuffix?, measured?): void

The section body, under a ## heading the caller writes. headingSuffix is appended to every ### so a feature slice says so wherever it is read.

Parameter Type
model ThreatModel
lines string[]
headingSuffix? string
measured? ReachCheck | null

void


generateAgentReachReport(model, measured?): string

The agent threat model on its own: the same section as the main report, with a header that says what it covers. guardlink report --agents.

Parameter Type
model ThreatModel
measured? ReachCheck | null

string


generateSequenceDiagram(model): string

Parameter Type
model ThreatModel

string

Re-exports generateMermaid


Re-exports generateReport