Skip to content

vaultmd / ParsedFrontmatter

Type Alias: ParsedFrontmatter

ParsedFrontmatter = object

Defined in: src/frontmatter/models/parsed-frontmatter.ts:4

The structured result returned by parseFrontmatter.

Properties

body

body: string

Defined in: src/frontmatter/models/parsed-frontmatter.ts:10

The note body: everything after the closing --- fence, or the full file content when there is no frontmatter.


frontmatter

frontmatter: Record<string, unknown>

Defined in: src/frontmatter/models/parsed-frontmatter.ts:6

The parsed YAML key-value pairs, or an empty object when absent/invalid.


tags

tags: string[]

Defined in: src/frontmatter/models/parsed-frontmatter.ts:8

Normalised tag tokens extracted from tags/tag frontmatter keys.


valid

valid: FrontmatterValidity

Defined in: src/frontmatter/models/parsed-frontmatter.ts:12

Whether the frontmatter block is flat-safe, present but unsafe, or absent.