markmv - v1.41.7
    Preparing search index...

    Interface ValidateResult

    Result of a validation operation containing all broken links found.

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

    Number of successfully authenticated links

    authRequiredLinks?: number

    Number of auth-required 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

    circularReferences?: string[]

    Circular reference details if found

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

    Files that had processing errors

    Type Declaration

    • error: string

      Error message

    • file: string

      Path of the file that failed to process

    • Optionalstack?: string

      Stack trace, when the error carried one

    filesProcessed: number

    Total number of files processed

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

    Internal links whose href form violates the enforced link format

    Type Declaration

    • expected: string

      The enforced form the link should take, relative or absolute

    • file: string

      Path of the file containing the link

    • href: string

      The link target as written

    • line: number

      Line number of the link

    freshLinks?: number

    Number of fresh links found

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

    Files missing required frontmatter fields

    Type Declaration

    • file: string

      Path of the file missing required fields

    • missingFields: string[]

      Required frontmatter fields the file does not define

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

    Git integration information

    Type Declaration

    • OptionalbaseRef?: string

      Base reference used for git diff

    • cachedFiles: number

      Files cached from previous validation

    • cacheHitRate: number

      Cache hit rate percentage

    • changedFiles: number

      Files changed according to git

    • OptionalcurrentCommit?: string

      Current git commit

    • enabled: boolean

      Whether git integration was used

    hasCircularReferences: boolean

    Whether circular references were detected

    processingTime: number

    Processing time in milliseconds

    staleLinks?: number

    Number of stale links found

    totalLinks: number

    Total number of links found

    Settings
    Member Visibility

    On This Page
    Properties