MetadataCache
Class: MetadataCache
Section titled “Class: MetadataCache”Defined in: cache.svelte.ts:564
Indexes parsed markdown metadata, tags, headings, and resolved links for the active vault.
Extends
Section titled “Extends”EventDispatcher<{changed: [TFile,string,CachedMetadata];deleted: [TFile,CachedMetadata|null];loaded: []; }>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new MetadataCache(
app):MetadataCache
Defined in: cache.svelte.ts:601
Parameters
Section titled “Parameters”Returns
Section titled “Returns”MetadataCache
Overrides
Section titled “Overrides”Properties
Section titled “Properties”
readonlyapp:App
Defined in: cache.svelte.ts:601
legacyStorage
Section titled “legacyStorage”
readonlylegacyStorage:ScopedVaultStore
Defined in: cache.svelte.ts:594
logger
Section titled “logger”
readonlylogger:Logger
Defined in: cache.svelte.ts:593
processors
Section titled “processors”processors:
Map<string,Set<MetadataProcessor>>
Defined in: cache.svelte.ts:586
Accessors
Section titled “Accessors”fileCache
Section titled “fileCache”Get Signature
Section titled “Get Signature”get fileCache():
Record<string, {hash:string;mtime:number;size:number; }>
Defined in: cache.svelte.ts:623
Returns
Section titled “Returns”Record<string, { hash: string; mtime: number; size: number; }>
metadataCache
Section titled “metadataCache”Get Signature
Section titled “Get Signature”get metadataCache():
Record<string,CachedMetadata>
Defined in: cache.svelte.ts:611
Returns
Section titled “Returns”Record<string, CachedMetadata>
resolvedLinks
Section titled “resolvedLinks”Get Signature
Section titled “Get Signature”get resolvedLinks():
Record<string,Record<string,number>>
Defined in: cache.svelte.ts:615
Returns
Section titled “Returns”Record<string, Record<string, number>>
unresolvedLinks
Section titled “unresolvedLinks”Get Signature
Section titled “Get Signature”get unresolvedLinks():
Record<string,Record<string,number>>
Defined in: cache.svelte.ts:619
Returns
Section titled “Returns”Record<string, Record<string, number>>
Methods
Section titled “Methods”addProcessor()
Section titled “addProcessor()”addProcessor(
ext,processor):void
Defined in: cache.svelte.ts:1082
Parameters
Section titled “Parameters”string
processor
Section titled “processor”MetadataProcessor
Returns
Section titled “Returns”void
dispatch()
Section titled “dispatch()”dispatch<
T>(eventName, …args):boolean
Defined in: events.ts:105
Type Parameters
Section titled “Type Parameters”T extends "deleted" | "changed" | "loaded"
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
…ArgumentMap<{ changed: [TFile, string, CachedMetadata]; deleted: [TFile, CachedMetadata | null]; loaded: []; }>[Extract<T, "deleted" | "changed" | "loaded">]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”emit()
Section titled “emit()”emit<
T>(eventName, …args):boolean
Defined in: events.ts:98
Type Parameters
Section titled “Type Parameters”T extends "deleted" | "changed" | "loaded"
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
…ArgumentMap<{ changed: [TFile, string, CachedMetadata]; deleted: [TFile, CachedMetadata | null]; loaded: []; }>[Extract<T, "deleted" | "changed" | "loaded">]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”fileToLinktext()
Section titled “fileToLinktext()”fileToLinktext(
file,sourcePath,omitMdExtension?):string
Defined in: cache.svelte.ts:1018
Parameters
Section titled “Parameters”sourcePath
Section titled “sourcePath”string
omitMdExtension?
Section titled “omitMdExtension?”boolean
Returns
Section titled “Returns”string
flushSnapshotSave()
Section titled “flushSnapshotSave()”flushSnapshotSave():
Promise<void>
Defined in: cache.svelte.ts:643
Returns
Section titled “Returns”Promise<void>
getAllItems()
Section titled “getAllItems()”getAllItems():
Map<TFile,CachedMetadata>
Defined in: cache.svelte.ts:627
Returns
Section titled “Returns”Map<TFile, CachedMetadata>
getCache()
Section titled “getCache()”getCache(
path):CachedMetadata|null
Defined in: cache.svelte.ts:903
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”CachedMetadata | null
getDirectReferencePaths()
Section titled “getDirectReferencePaths()”getDirectReferencePaths(
sourcePath):string[]
Defined in: cache.svelte.ts:907
Parameters
Section titled “Parameters”sourcePath
Section titled “sourcePath”string
Returns
Section titled “Returns”string[]
getDirectReferencingPaths()
Section titled “getDirectReferencingPaths()”getDirectReferencingPaths(
targetPath):string[]
Defined in: cache.svelte.ts:932
Parameters
Section titled “Parameters”targetPath
Section titled “targetPath”string
Returns
Section titled “Returns”string[]
getFileCache()
Section titled “getFileCache()”getFileCache(
file):CachedMetadata|null
Defined in: cache.svelte.ts:899
Parameters
Section titled “Parameters”Returns
Section titled “Returns”CachedMetadata | null
getFirstLinkpathDest()
Section titled “getFirstLinkpathDest()”getFirstLinkpathDest(
linkpath,sourcePath):TFile|null
Defined in: cache.svelte.ts:962
Parameters
Section titled “Parameters”linkpath
Section titled “linkpath”string
sourcePath
Section titled “sourcePath”string
Returns
Section titled “Returns”TFile | null
isDirectlyAffectedByPathChange()
Section titled “isDirectlyAffectedByPathChange()”isDirectlyAffectedByPathChange(
watchedPath,changedPath):boolean
Defined in: cache.svelte.ts:947
Parameters
Section titled “Parameters”watchedPath
Section titled “watchedPath”string | null | undefined
changedPath
Section titled “changedPath”string | null | undefined
Returns
Section titled “Returns”boolean
load()
Section titled “load()”load():
Promise<void>
Defined in: cache.svelte.ts:780
Returns
Section titled “Returns”Promise<void>
off<
T>(eventName,listener,context?,once?):void
Defined in: events.ts:78
Type Parameters
Section titled “Type Parameters”T extends "deleted" | "changed" | "loaded"
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
listener
Section titled “listener”(…args) => void
context?
Section titled “context?”any
boolean
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”offref()
Section titled “offref()”offref<
T>(ref):void
Defined in: events.ts:87
Type Parameters
Section titled “Type Parameters”T extends "deleted" | "changed" | "loaded"
Parameters
Section titled “Parameters”EventRef<{ changed: [TFile, string, CachedMetadata]; deleted: [TFile, CachedMetadata | null]; loaded: []; }, T>
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”on<
T>(eventName,listener,context?):EventRef<{changed: [TFile,string,CachedMetadata];deleted: [TFile,CachedMetadata|null];loaded: []; },T,any>
Defined in: events.ts:48
Type Parameters
Section titled “Type Parameters”T extends "deleted" | "changed" | "loaded"
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
listener
Section titled “listener”(…args) => void
context?
Section titled “context?”any
Returns
Section titled “Returns”EventRef<{ changed: [TFile, string, CachedMetadata]; deleted: [TFile, CachedMetadata | null]; loaded: []; }, T, any>
Inherited from
Section titled “Inherited from”once()
Section titled “once()”once<
T>(eventName,listener,context?):EventRef<{changed: [TFile,string,CachedMetadata];deleted: [TFile,CachedMetadata|null];loaded: []; },T,any>
Defined in: events.ts:63
Type Parameters
Section titled “Type Parameters”T extends "deleted" | "changed" | "loaded"
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
listener
Section titled “listener”(…args) => void
context?
Section titled “context?”any
Returns
Section titled “Returns”EventRef<{ changed: [TFile, string, CachedMetadata]; deleted: [TFile, CachedMetadata | null]; loaded: []; }, T, any>
Inherited from
Section titled “Inherited from”pathDirectlyReferences()
Section titled “pathDirectlyReferences()”pathDirectlyReferences(
sourcePath,targetPath):boolean
Defined in: cache.svelte.ts:924
Parameters
Section titled “Parameters”sourcePath
Section titled “sourcePath”string
targetPath
Section titled “targetPath”string
Returns
Section titled “Returns”boolean
processFileCache()
Section titled “processFileCache()”processFileCache(
file):Promise<CachedMetadata|null>
Defined in: cache.svelte.ts:1291
Parameters
Section titled “Parameters”string | TFile | null
Returns
Section titled “Returns”Promise<CachedMetadata | null>
read()
Section titled “read()”read(
content,file):Promise<CachedMetadata|null>
Defined in: cache.svelte.ts:1301
Parameters
Section titled “Parameters”content
Section titled “content”string
Returns
Section titled “Returns”Promise<CachedMetadata | null>
rebuild()
Section titled “rebuild()”rebuild():
Promise<void>
Defined in: cache.svelte.ts:1044
Returns
Section titled “Returns”Promise<void>
removeProcessor()
Section titled “removeProcessor()”removeProcessor(
ext,processor):boolean
Defined in: cache.svelte.ts:1091
Parameters
Section titled “Parameters”string
processor
Section titled “processor”MetadataProcessor
Returns
Section titled “Returns”boolean
saveSnapshotNow()
Section titled “saveSnapshotNow()”saveSnapshotNow(
options?):Promise<void>
Defined in: cache.svelte.ts:648
Parameters
Section titled “Parameters”options?
Section titled “options?”forceBackup?
Section titled “forceBackup?”boolean
Returns
Section titled “Returns”Promise<void>
scheduleSnapshotSave()
Section titled “scheduleSnapshotSave()”scheduleSnapshotSave():
void
Defined in: cache.svelte.ts:639
Returns
Section titled “Returns”void
toJSON()
Section titled “toJSON()”toJSON():
object
Defined in: cache.svelte.ts:673
Returns
Section titled “Returns”object
fileCache
Section titled “fileCache”fileCache:
object
Index Signature
Section titled “Index Signature”[key: string]: object
metadataCache
Section titled “metadataCache”metadataCache:
object
Index Signature
Section titled “Index Signature”[key: string]: object
resolvedLinks
Section titled “resolvedLinks”resolvedLinks:
object
Index Signature
Section titled “Index Signature”[key: string]: object
unresolvedLinks
Section titled “unresolvedLinks”unresolvedLinks:
object
Index Signature
Section titled “Index Signature”[key: string]: object
trigger()
Section titled “trigger()”trigger<
T>(eventName, …args):boolean
Defined in: events.ts:91
Type Parameters
Section titled “Type Parameters”T extends "deleted" | "changed" | "loaded"
Parameters
Section titled “Parameters”eventName
Section titled “eventName”T
…ArgumentMap<{ changed: [TFile, string, CachedMetadata]; deleted: [TFile, CachedMetadata | null]; loaded: []; }>[Extract<T, "deleted" | "changed" | "loaded">]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”tryTrigger()
Section titled “tryTrigger()”tryTrigger<
T>(evt, …args):void
Defined in: events.ts:112
Type Parameters
Section titled “Type Parameters”T extends "deleted" | "changed" | "loaded"
Parameters
Section titled “Parameters”EventRef<{ changed: [TFile, string, CachedMetadata]; deleted: [TFile, CachedMetadata | null]; loaded: []; }, T>
…ArgumentMap<{ changed: [TFile, string, CachedMetadata]; deleted: [TFile, CachedMetadata | null]; loaded: []; }>[Extract<T, "deleted" | "changed" | "loaded">]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”writeFrontmatter()
Section titled “writeFrontmatter()”writeFrontmatter(
file,data):string
Defined in: cache.svelte.ts:1318
Parameters
Section titled “Parameters”FrontMatterCache
Returns
Section titled “Returns”string