Skip to content

BrokenLinkCandidateFinderConstructorParams

The parameters for BrokenLinkCandidateFinder.

Import:

import type { BrokenLinkCandidateFinderConstructorParams } from '@mnaoumov/obsidian-lib/broken-link-candidates';

Signature:

export interface BrokenLinkCandidateFinderConstructorParams

Properties

PropertyTypeDescription
aliasesByPathReadonlyMap<string, readonly string[]>Each note's aliases, by note path.
filePathsreadonly string[]Every file in the vault.
folderNoteFileNamesreadonly string[]The file names a folder note is stored under, such as index.md. Such a name says nothing about which note it is, so a same-name candidate must share its folder's name too, and the old name an alias is matched against is the folder's.
gitRenamesReadonlyMap<string, GitRename>The vault's git renames: each old vault path to the path it was renamed to, chains already followed.
titlesByPathReadonlyMap<string, string>Each note's title, by note path.