CachedMetadata

Official

Cached metadata for a note.

Import:

import type { CachedMetadata } from 'obsidian';

Signature:

export interface CachedMetadata

Properties

Property	Type	Description
blocks?	Record<string, BlockCache>	The cache of the blocks in the note. ```markdown foo ^bar` ``
embeds?	EmbedCache[]	The cache of the embeds in the note. ```markdown ![[wikilink]] ![[wikilink\|alias]] !alias` ``
footnoteRefs?	FootnoteRefCache[]	The cache of the footnote references in the note. ```markdown foo [^1] [^1]: bar baz [^qux] [^qux]: quux```
footnotes?	FootnoteCache[]	The cache of the footnotes in the note. ```markdown foo [^1] [^1]: bar baz [^qux] [^qux]: quux```
frontmatter?	FrontMatterCache	The cache of the frontmatter in the note. Frontmatter is a block of metadata that is used to store information about the note. ```markdown --- key1: "value1", key2: 42 ---` ``
frontmatterLinks?	FrontmatterLinkCache[]	The cache of the links in the frontmatter. ```markdown --- key1: "[[wikilink]]" key2: "[[wikilink\|alias]]" ---` ``
frontmatterPosition?	Pos	Position of the frontmatter in the file. ```markdown --- key1: "value1", key2: 42 ---```
headings?	HeadingCache[]	The cache of the headings in the note. ```markdown # foo ## bar ### baz` ``
links?	LinkCache[]	The cache of the links in the note. ```markdown [[wikilink]] [[wikilink\|alias]] alias` ``
listItems?	ListItemCache[]	The cache of the list items in the note. List items are markdown blocks that are used to create lists. ```markdown - Unordered List Item 1 - Unordered List Item 2 - Unordered List Item 3 1. Ordered List Item 1 2. Ordered List Item 2 3. Ordered List Item 3```
referenceLinks?	ReferenceLinkCache[]	The cache of the reference links in the note. ```markdown [google] [google]: https://google.com```
sections?	SectionCache[]	The cache of the sections in the note. Sections are root level markdown blocks, which can be used to divide the document up. ```markdown # Heading section Paragraph section > [!NOTE] > Callout section```
tags?	TagCache[]	The cache of the tags in the note. ```markdown --- tags: - foo - bar --- #baz```

Links to this page: