markmv - v1.41.7
    Preparing search index...

    Interface RefactorIndexResult

    Result of an index file refactoring operation.

    interface RefactorIndexResult {
        changes: OperationChange[];
        errors: string[];
        filesWithUpdatedLinks: string[];
        linksUpdated: number;
        parseFailures: { error: string; file: string }[];
        sourcePath: string;
        success: boolean;
        targetPath?: string;
        warnings: string[];
    }
    Index
    changes errors filesWithUpdatedLinks linksUpdated parseFailures sourcePath success targetPath? warnings
    changes: OperationChange[]

    Detailed link changes recorded by the move machinery

    errors: string[]

    Errors that prevented the operation

    filesWithUpdatedLinks: string[]

    Distinct files whose links were rewritten

    linksUpdated: number

    Number of inbound links rewritten to the new name

    parseFailures: { error: string; file: string }[]

    Files that failed to parse during the operation; their links could not be checked or rewritten

    Type Declaration

    • error: string

      Parse error message

    • file: string

      Path of the file that failed to parse

    sourcePath: string

    Absolute path of the file before the rename

    success: boolean

    Whether the operation was successful

    targetPath?: string

    Absolute path the file is renamed to; absent when no target could be derived from the request

    warnings: string[]

    Warnings reported by the move machinery

    Settings
    Member Visibility

    On This Page
    Properties