markmv - v1.39.2
    Preparing search index...

    Interface ValidateResult

    Result of a validation operation containing all broken links found.

    interface ValidateResult {
        filesProcessed: number;
        totalLinks: number;
        brokenLinks: number;
        brokenLinksByFile: Record<string, ExtendedBrokenLink[]>;
        brokenLinksByType: Partial<Record<LinkType, ExtendedBrokenLink[]>>;
        fileErrors: { file: string; error: string; stack?: string }[];
        hasCircularReferences: boolean;
        circularReferences?: string[];
        processingTime: number;
        gitInfo?: {
            enabled: boolean;
            changedFiles: number;
            cachedFiles: number;
            cacheHitRate: number;
            baseRef?: string;
            currentCommit?: string;
        };
        staleLinks?: number;
        freshLinks?: number;
        authRequiredLinks?: number;
        authenticatedLinks?: number;
        frontmatterViolations: { file: string; missingFields: string[] }[];
        formatViolations: {
            file: string;
            href: string;
            line: number;
            expected: string;
        }[];
    }
    Index
    filesProcessed totalLinks brokenLinks brokenLinksByFile brokenLinksByType fileErrors hasCircularReferences circularReferences? processingTime gitInfo? staleLinks? freshLinks? authRequiredLinks? authenticatedLinks? frontmatterViolations formatViolations
    filesProcessed: number

    Total number of files processed

    totalLinks: number

    Total number of links found

    brokenLinks: number

    Total number of broken links found

    brokenLinksByFile: Record<string, ExtendedBrokenLink[]>

    Broken links grouped by file

    brokenLinksByType: Partial<Record<LinkType, ExtendedBrokenLink[]>>

    Broken links grouped by type

    fileErrors: { file: string; error: string; stack?: string }[]

    Files that had processing errors

    hasCircularReferences: boolean

    Whether circular references were detected

    circularReferences?: string[]

    Circular reference details if found

    processingTime: number

    Processing time in milliseconds

    gitInfo?: {
        enabled: boolean;
        changedFiles: number;
        cachedFiles: number;
        cacheHitRate: number;
        baseRef?: string;
        currentCommit?: string;
    }

    Git integration information

    Type Declaration

    • enabled: boolean

      Whether git integration was used

    • changedFiles: number

      Files changed according to git

    • cachedFiles: number

      Files cached from previous validation

    • cacheHitRate: number

      Cache hit rate percentage

    • OptionalbaseRef?: string

      Base reference used for git diff

    • OptionalcurrentCommit?: string

      Current git commit

    staleLinks?: number

    Number of stale links found

    freshLinks?: number

    Number of fresh links found

    authRequiredLinks?: number

    Number of auth-required links found

    authenticatedLinks?: number

    Number of successfully authenticated links

    frontmatterViolations: { file: string; missingFields: string[] }[]

    Files missing required frontmatter fields

    formatViolations: { file: string; href: string; line: number; expected: string }[]

    Internal links whose href form violates the enforced link format

    Settings
    Member Visibility

    On This Page
    Properties