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.
Functions
Section titled “Functions”emitAgentReach()
Section titled “emitAgentReach()”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.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
model |
ThreatModel |
lines |
string[] |
headingSuffix? |
string |
measured? |
ReachCheck | null |
Returns
Section titled “Returns”void
generateAgentReachReport()
Section titled “generateAgentReachReport()”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.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
model |
ThreatModel |
measured? |
ReachCheck | null |
Returns
Section titled “Returns”string
generateSequenceDiagram()
Section titled “generateSequenceDiagram()”generateSequenceDiagram(
model):string
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
model |
ThreatModel |
Returns
Section titled “Returns”string
References
Section titled “References”generateMermaid
Section titled “generateMermaid”Re-exports generateMermaid
generateReport
Section titled “generateReport”Re-exports generateReport

