vaultmd

Appearance

vaultmd / ReadNoteResult

Type Alias: ReadNoteResult ​

ReadNoteResult = object

Defined in: src/notes/models/read-note-result.ts:5

The structured result returned by NotesApi.readNote.

Properties ​

optional backlinks?: Backlink[]

Defined in: src/notes/models/read-note-result.ts:17

Notes that link back to this note (only populated when withLinks: true).

body ​

body: string

Defined in: src/notes/models/read-note-result.ts:11

The note body: everything after the closing --- fence.

frontmatter ​

frontmatter: Record<string, unknown>

Defined in: src/notes/models/read-note-result.ts:7

The parsed YAML frontmatter key-value map (empty object when absent or invalid).

outbound? ​

optional outbound?: OutboundLink[]

Defined in: src/notes/models/read-note-result.ts:15

Outbound links from this note (only populated when withLinks: true).

tags ​

tags: string[]

Defined in: src/notes/models/read-note-result.ts:9

Normalised tag tokens extracted from frontmatter.

valid ​

valid: FrontmatterValidity

Defined in: src/notes/models/read-note-result.ts:13

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