API Reference

Showing 30 of 30 entries

Method	Description	Category	Returns	Accepts
createExtendedMetadataCache	Create isolated instance	lifecycle	ExtendedMetadataCacheAPI	App, options?
Events	Cache lifecycle events: ready, file-updated, rebuild-progress	lifecycle	—	—
getAllAliasesWithFiles	All aliases with their file sets	aliases	ReadonlyMap	none
getAllBacklinksWithFiles	All backlink targets with their source file sets	backlinks	ReadonlyMap	none
getAllEmbedsWithFiles	All embed targets with their embedding file sets	embeds	ReadonlyMap	none
getAllFrontmatterKeysWithFiles	All frontmatter keys with their file sets	frontmatter	ReadonlyMap	none
getAllHeadingsWithFiles	All headings with their file sets	headings	ReadonlyMap	none
getAllTagsWithFiles	All tags with their file sets	tags	ReadonlyMap	none
getAllTaskStatusesWithFiles	All task statuses with their file sets	tasks	ReadonlyMap	none
getAPI	Acquire shared singleton instance	lifecycle	ExtendedMetadataCacheHandle	App, options?
getBacklinksForFile	Files linking to target (combined)	backlinks	ReadonlySet<string>	TFile \| string
getBacklinksFromBody	Body-only backlinks	backlinks	ReadonlySet<string>	TFile \| string
getBacklinksFromFrontmatter	Frontmatter-only backlinks	backlinks	ReadonlySet<string>	TFile \| string
getFilesEmbedding	Files that embed the target	embeds	ReadonlySet<string>	TFile \| string
getFilesWithAlias	Files with a specific alias	aliases	ReadonlySet<string>	string
getFilesWithCompletedTasks	Files with completed tasks	tasks	ReadonlySet<string>	none
getFilesWithFrontmatterKey	Files with a frontmatter key	frontmatter	ReadonlySet<string>	string
getFilesWithFrontmatterValue	Files with key = value	frontmatter	ReadonlySet<string>	string, unknown
getFilesWithHeading	Files containing a heading	headings	ReadonlySet<string>	string
getFilesWithOpenTasks	Files with incomplete tasks	tasks	ReadonlySet<string>	none
getFilesWithTag	Files with tag (body + frontmatter combined)	tags	ReadonlySet<string>	string
getFilesWithTagInBody	Files with tag in note body only	tags	ReadonlySet<string>	string
getFilesWithTagInFrontmatter	Files with tag in frontmatter only	tags	ReadonlySet<string>	string
getFilesWithTasks	Files containing any tasks	tasks	ReadonlySet<string>	none
getFilesWithTaskStatus	Files with tasks of specific status(es)	tasks	ReadonlySet<string>	string \| string[]
getFileWithBlockId	File defining a block ID	blocks	TFile \| null	string
getUnresolvedBacklinks	Files with unresolved links to a name	backlinks	ReadonlySet<string>	string
hasAPI	Check if singleton exists	lifecycle	boolean	none
index	API reference and function descriptions.	—	—	—
Options	Configuration options: chunkSize, persist, flushDebounceMs, flushIntervalMs	lifecycle	—	—

Showing 30 of 30 entries

Method	Description	Returns	Accepts
Category aliases2
getAllAliasesWithFiles	All aliases with their file sets	ReadonlyMap	none
getFilesWithAlias	Files with a specific alias	ReadonlySet<string>	string
Category backlinks5
getAllBacklinksWithFiles	All backlink targets with their source file sets	ReadonlyMap	none
getBacklinksForFile	Files linking to target (combined)	ReadonlySet<string>	TFile \| string
getBacklinksFromBody	Body-only backlinks	ReadonlySet<string>	TFile \| string
getBacklinksFromFrontmatter	Frontmatter-only backlinks	ReadonlySet<string>	TFile \| string
getUnresolvedBacklinks	Files with unresolved links to a name	ReadonlySet<string>	string
Category blocks1
getFileWithBlockId	File defining a block ID	TFile \| null	string
Category embeds2
getAllEmbedsWithFiles	All embed targets with their embedding file sets	ReadonlyMap	none
getFilesEmbedding	Files that embed the target	ReadonlySet<string>	TFile \| string
Category frontmatter3
getAllFrontmatterKeysWithFiles	All frontmatter keys with their file sets	ReadonlyMap	none
getFilesWithFrontmatterKey	Files with a frontmatter key	ReadonlySet<string>	string
getFilesWithFrontmatterValue	Files with key = value	ReadonlySet<string>	string, unknown
Category headings2
getAllHeadingsWithFiles	All headings with their file sets	ReadonlyMap	none
getFilesWithHeading	Files containing a heading	ReadonlySet<string>	string
Category lifecycle5
Events	Cache lifecycle events: ready, file-updated, rebuild-progress	—	—
Options	Configuration options: chunkSize, persist, flushDebounceMs, flushIntervalMs	—	—
createExtendedMetadataCache	Create isolated instance	ExtendedMetadataCacheAPI	App, options?
getAPI	Acquire shared singleton instance	ExtendedMetadataCacheHandle	App, options?
hasAPI	Check if singleton exists	boolean	none
Category tags4
getAllTagsWithFiles	All tags with their file sets	ReadonlyMap	none
getFilesWithTag	Files with tag (body + frontmatter combined)	ReadonlySet<string>	string
getFilesWithTagInBody	Files with tag in note body only	ReadonlySet<string>	string
getFilesWithTagInFrontmatter	Files with tag in frontmatter only	ReadonlySet<string>	string
Category tasks5
getAllTaskStatusesWithFiles	All task statuses with their file sets	ReadonlyMap	none
getFilesWithCompletedTasks	Files with completed tasks	ReadonlySet<string>	none
getFilesWithOpenTasks	Files with incomplete tasks	ReadonlySet<string>	none
getFilesWithTaskStatus	Files with tasks of specific status(es)	ReadonlySet<string>	string \| string[]
getFilesWithTasks	Files containing any tasks	ReadonlySet<string>	none
Category Uncategorized1
index	API reference and function descriptions.	—	—

Showing 2 of 2 entries

Method	Description	Category	Returns	Accepts
getAllAliasesWithFiles	All aliases with their file sets	aliases	ReadonlyMap	none
getFilesWithAlias	Files with a specific alias	aliases	ReadonlySet<string>	string

Showing 5 of 5 entries

Method	Description	Category	Returns	Accepts
getAllBacklinksWithFiles	All backlink targets with their source file sets	backlinks	ReadonlyMap	none
getBacklinksForFile	Files linking to target (combined)	backlinks	ReadonlySet<string>	TFile \| string
getBacklinksFromBody	Body-only backlinks	backlinks	ReadonlySet<string>	TFile \| string
getBacklinksFromFrontmatter	Frontmatter-only backlinks	backlinks	ReadonlySet<string>	TFile \| string
getUnresolvedBacklinks	Files with unresolved links to a name	backlinks	ReadonlySet<string>	string

Showing 1 of 1 entries

Method	Description	Category	Returns	Accepts
getFileWithBlockId	File defining a block ID	blocks	TFile \| null	string

Showing 2 of 2 entries

Method	Description	Category	Returns	Accepts
getAllEmbedsWithFiles	All embed targets with their embedding file sets	embeds	ReadonlyMap	none
getFilesEmbedding	Files that embed the target	embeds	ReadonlySet<string>	TFile \| string

Showing 3 of 3 entries

Method	Description	Category	Returns	Accepts
getAllFrontmatterKeysWithFiles	All frontmatter keys with their file sets	frontmatter	ReadonlyMap	none
getFilesWithFrontmatterKey	Files with a frontmatter key	frontmatter	ReadonlySet<string>	string
getFilesWithFrontmatterValue	Files with key = value	frontmatter	ReadonlySet<string>	string, unknown

Showing 2 of 2 entries

Method	Description	Category	Returns	Accepts
getAllHeadingsWithFiles	All headings with their file sets	headings	ReadonlyMap	none
getFilesWithHeading	Files containing a heading	headings	ReadonlySet<string>	string

Showing 5 of 5 entries

Method	Description	Category	Returns	Accepts
createExtendedMetadataCache	Create isolated instance	lifecycle	ExtendedMetadataCacheAPI	App, options?
Events	Cache lifecycle events: ready, file-updated, rebuild-progress	lifecycle	—	—
getAPI	Acquire shared singleton instance	lifecycle	ExtendedMetadataCacheHandle	App, options?
hasAPI	Check if singleton exists	lifecycle	boolean	none
Options	Configuration options: chunkSize, persist, flushDebounceMs, flushIntervalMs	lifecycle	—	—

Showing 4 of 4 entries

Method	Description	Category	Returns	Accepts
getAllTagsWithFiles	All tags with their file sets	tags	ReadonlyMap	none
getFilesWithTag	Files with tag (body + frontmatter combined)	tags	ReadonlySet<string>	string
getFilesWithTagInBody	Files with tag in note body only	tags	ReadonlySet<string>	string
getFilesWithTagInFrontmatter	Files with tag in frontmatter only	tags	ReadonlySet<string>	string

Showing 5 of 5 entries

Method	Description	Category	Returns	Accepts
getAllTaskStatusesWithFiles	All task statuses with their file sets	tasks	ReadonlyMap	none
getFilesWithCompletedTasks	Files with completed tasks	tasks	ReadonlySet<string>	none
getFilesWithOpenTasks	Files with incomplete tasks	tasks	ReadonlySet<string>	none
getFilesWithTasks	Files containing any tasks	tasks	ReadonlySet<string>	none
getFilesWithTaskStatus	Files with tasks of specific status(es)	tasks	ReadonlySet<string>	string \| string[]

Extended Metadata Cache

Explorer

API Reference

Events

Options

createExtendedMetadataCache

getAPI

getAllAliasesWithFiles

getAllBacklinksWithFiles

getAllEmbedsWithFiles

getAllFrontmatterKeysWithFiles

getAllHeadingsWithFiles

getAllTagsWithFiles

getAllTaskStatusesWithFiles

getBacklinksForFile

getBacklinksFromBody

getBacklinksFromFrontmatter

getFileWithBlockId

getFilesEmbedding

getFilesWithAlias

getFilesWithCompletedTasks

getFilesWithFrontmatterKey

getFilesWithFrontmatterValue

getFilesWithHeading

getFilesWithOpenTasks

getFilesWithTag

getFilesWithTagInBody

getFilesWithTagInFrontmatter

getFilesWithTaskStatus

getFilesWithTasks

getUnresolvedBacklinks

hasAPI