Interface TreeFileNode

A markdown file leaf in the rendered tree.

Field order is the serialisation order used by the JSON output and is kept stable.

interface TreeFileNode {
    name: string;
    path: string;
    wordCount: number;
    linkCount: number;
    brokenInternalLinkCount: number;
    orphaned: boolean;
}

Properties

name: string

File name including extension

path: string

Path relative to the scan root, with forward slashes

wordCount: number

Word count outside code spans and fences

linkCount: number

Total number of parsed links of every type

brokenInternalLinkCount: number

Internal links whose target file does not exist

orphaned: boolean

Whether no other scanned file links to this file