MetadataCache ​

Extends Events

Linktext is any internal link that is composed of a path and a subpath, such as "My note#Heading" Linkpath (or path) is the path part of a linktext Subpath is the heading/block ID part of a linktext.

Constructor ​

constructor();

Properties ​

resolvedLinks ​

resolvedLinks: Record<string, Record<string, number>>

Contains all resolved links. This object maps each source file's path to an object of destination file paths with the link count. Source and destination paths are all vault absolute paths that comes from TFile.path and can be used with Vault.getAbstractFileByPath(path).

unresolvedLinks ​

unresolvedLinks: Record<string, Record<string, number>>

Contains all unresolved links. This object maps each source file to an object of unknown destinations with count. Source paths are all vault absolute paths, similar to resolvedLinks.

Methods ​

getFirstLinkpathDest ​

getFirstLinkpathDest(linkpath: string, sourcePath: string): TFile | null;

Get the best match for a linkpath.

getFileCache ​

getFileCache(file: TFile): CachedMetadata | null;

getCache ​

getCache(path: string): CachedMetadata | null;

fileToLinktext ​

fileToLinktext(file: TFile, sourcePath: string, omitMdExtension?: boolean): string;

Generates a linktext for a file.

If file name is unique, use the filename. If not unique, use full path.

on ​

on(name: 'changed', callback: (file: TFile, data: string, cache: CachedMetadata) => any, ctx?: any): EventRef;

Called when a file has been indexed, and its (updated) cache is now available.

Note: This is not called when a file is renamed for performance reasons. You must hook the vault rename event for those. (Details: https://github.com/obsidianmd/obsidian-api/issues/77) Called when a file has been deleted. A best-effort previous version of the cached metadata is presented, but it could be null in case the file was not successfully cached previously. Called when a file has been resolved for resolvedLinks and unresolvedLinks. This happens sometimes after a file has been indexed. Called when all files has been resolved. This will be fired each time files get modified after the initial load.

on ​

on(name: 'deleted', callback: (file: TFile, prevCache: CachedMetadata | null) => any, ctx?: any): EventRef;

Called when a file has been indexed, and its (updated) cache is now available.

Note: This is not called when a file is renamed for performance reasons. You must hook the vault rename event for those. (Details: https://github.com/obsidianmd/obsidian-api/issues/77) Called when a file has been deleted. A best-effort previous version of the cached metadata is presented, but it could be null in case the file was not successfully cached previously. Called when a file has been resolved for resolvedLinks and unresolvedLinks. This happens sometimes after a file has been indexed. Called when all files has been resolved. This will be fired each time files get modified after the initial load.

on ​

on(name: 'resolve', callback: (file: TFile) => any, ctx?: any): EventRef;

Called when a file has been indexed, and its (updated) cache is now available.

Note: This is not called when a file is renamed for performance reasons. You must hook the vault rename event for those. (Details: https://github.com/obsidianmd/obsidian-api/issues/77) Called when a file has been deleted. A best-effort previous version of the cached metadata is presented, but it could be null in case the file was not successfully cached previously. Called when a file has been resolved for resolvedLinks and unresolvedLinks. This happens sometimes after a file has been indexed. Called when all files has been resolved. This will be fired each time files get modified after the initial load.

on ​

on(name: 'resolved', callback: () => any, ctx?: any): EventRef;

Called when a file has been indexed, and its (updated) cache is now available.

Note: This is not called when a file is renamed for performance reasons. You must hook the vault rename event for those. (Details: https://github.com/obsidianmd/obsidian-api/issues/77) Called when a file has been deleted. A best-effort previous version of the cached metadata is presented, but it could be null in case the file was not successfully cached previously. Called when a file has been resolved for resolvedLinks and unresolvedLinks. This happens sometimes after a file has been indexed. Called when all files has been resolved. This will be fired each time files get modified after the initial load.