markmv - v1.26.2
    Preparing search index...

    Class LinkValidator

    Validates markdown links and identifies broken or problematic references.

    The LinkValidator checks various types of links including internal file references, external URLs, and Claude import syntax. It provides comprehensive reporting of validation issues and supports different validation modes for different use cases.

    Basic link validation

    const validator = new LinkValidator({
    checkExternal: true,
    strictInternal: true,
    externalTimeout: 10000
    });

    const result = await validator.validateFile('docs/api.md');

    if (!result.isValid) {
    console.log(`Found ${result.brokenLinks.length} broken links`);
    result.brokenLinks.forEach(link => {
    console.log(`- ${link.href} (line ${link.line}): ${link.reason}`);
    });
    }

    Batch validation

    const validator = new LinkValidator();
    const files = ['docs/guide.md', 'docs/api.md', 'docs/examples.md'];

    const results = await validator.validateFiles(files);
    const totalBroken = results.reduce((sum, r) => sum + r.brokenLinks.length, 0);
    console.log(`Found ${totalBroken} broken links across ${files.length} files`);
    Index

    Constructors

    constructor

    Methods

    validateFiles validateFile validateLink validateLinkIntegrity validateLinks checkCircularReferences

    Constructors

    Methods

    • Parameters

      Returns Promise<
          {
              valid: boolean;
              circularReferences: string[][];
              brokenLinks: BrokenLink[];
              warnings: string[];
          },
      >

    • Validates a specific array of links from a single file.

      Parameters

      • links: MarkdownLink[]

        Array of links to validate

      • sourceFile: string

        Path to the source file containing the links

      Returns Promise<{ brokenLinks: BrokenLink[] }>

      Promise resolving to validation result with broken links

    • Check for circular references - overloaded method that supports both parsed files and file paths.

      Parameters

      Returns Promise<string[][]>

    • Check for circular references - overloaded method that supports both parsed files and file paths.

      Parameters

      • files: string[]

      Returns Promise<{ hasCircularReferences: boolean; circularPaths?: string[] }>

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods