Interface RenameNoteResult

Envelope returned by renameNote.

total_links_rewritten is the sum across files_updated. dry_run echoes the input so the caller can detect a forgotten flag.

interface RenameNoteResult {
    dry_run: boolean;
    files_updated: RenameProposal[];
    from: string;
    to: string;
    total_links_rewritten: number;
}

Properties

dry_run: boolean

Whether the file system was actually mutated.

files_updated: RenameProposal[]

Per-file rewrites. The source file is the last entry, at its NEW path.

from: string

Source path (with .md).

to: string

Destination path (with .md).

total_links_rewritten: number

Sum of rewrites across files_updated.