Interface GenerateUsageResult

The rendered Dependency & Ownership report plus the proven DependencyEdges and findings it's built from.

interface GenerateUsageResult {
    content: string;
    edges: readonly DependencyEdge[];
    findings: readonly ReportFinding[];
    location: string | undefined;
    warnings: readonly ParseWarning[];
}

Properties

content: string

The rendered Markdown content.

edges: readonly DependencyEdge[]

Every proven consumer relationship the scan found.

findings: readonly ReportFinding[]

Ownership/usage findings derived from edges (e.g. ABANDONED_CAPABILITY).

location: string | undefined

Where this report is intended to be written, or undefined when the caller requested only the scan results -- see GenerateUsageOptions.location.

warnings: readonly ParseWarning[]

Parse/resolution warnings from the scan, never blocking.