FrontMatterInfo

Official

Both Official Unofficial

Both Own Inherited

The information about the frontmatter in the note.

Import:

import type { FrontMatterInfo } from 'obsidian';

Signature:

export interface FrontMatterInfo

Properties

	Property	Type	Description
	contentStart	number	Offset where the frontmatter block ends (including the ---)
	exists	boolean	Whether this file has a frontmatter block.
	from	number	Start offset of the frontmatter contents (excluding the ---).
	frontmatter	string	String representation of the frontmatter.
	to	number	End offset of the frontmatter contents (excluding the ---).

---

Links to this page:

• getFrontMatterInfo