VaultMD / UpdateOp

Type Alias: UpdateOp

UpdateOp = { editByMatch: { new: string; old: string; }; } | { append: string; } | { prepend: string; } | { setBody: string; } | { setSection: { body: string; heading: string; }; }

Defined in: src/notes/models/update-op.ts:5

Describes a mutation to apply to a note's body via NotesApi.updateNote. Exactly one variant must be set per call.

Union Members

Type Literal

{ editByMatch: { new: string; old: string; }; }

editByMatch

editByMatch: object

Find-and-replace a unique substring in the note body. The frontmatter block is excluded from the search and left untouched (use NotesApi.editFrontmatter for that). The old text must match exactly once within the body — zero matches throw NO_MATCH, multiple matches throw AMBIGUOUS_MATCH.

editByMatch.new

new: string

Replacement text for the matched substring.

editByMatch.old

old: string

Exact substring to locate in the note body.

---

Type Literal

{ append: string; }

append

append: string

Text to append verbatim to the end of the note body, with a newline inserted first when the existing content does not end in one. Creates the note when it does not exist.

---

Type Literal

{ prepend: string; }

prepend

prepend: string

Text to insert at the START of the note body — after the frontmatter block, never before it — with a newline inserted between it and the existing body when it does not already end in one. Creates the note when it does not exist.

---

Type Literal

{ setBody: string; }

setBody

setBody: string

Replacement for the whole note body; the frontmatter block is preserved verbatim. Does NOT create a missing note (throws REFUSE_CREATE) — use NotesApi.createNote for that.

---

Type Literal

{ setSection: { body: string; heading: string; }; }

setSection

setSection: object

Replace the body of the section opened by a heading, leaving the heading line itself untouched. The replaced span runs from the first non-blank line after the heading to the last non-blank line before the next heading of the same or a shallower level, so blank lines at either edge are preserved and none are invented. An empty body empties the section; a whitespace-only body is treated as empty.

Does NOT create a missing note — like editByMatch it needs something to match, so a missing file throws NO_MATCH.

The payload itself is trimmed at its edges to match: blank lines at its head are stripped, and blank lines at its tail collapse onto the newline that already terminates its last non-blank line. Those edge bytes would otherwise fall outside the section's span and be re-added on every repeated write. The written text then carries the terminator the replaced span itself had, so a file keeps its trailing newline — or its absence — wherever the section sits. The payload's interior, including its line endings, is untouched.

Emptying a section also drops the blank run between the heading and the old body, since it merges with the run before the next heading; that run is therefore not recoverable by writing the section again.

The payload may not restructure the document around it. All four throw VALIDATION_ERROR: a heading of the same or a shallower level than the target; a setext underline — a === / --- line closing a paragraph, which extractHeadings cannot see but every renderer can, while the same line after a list, a quote or another break is an ordinary thematic break and passes; a heading whose text collides with one already in the note, which would leave the caller locked out with AMBIGUOUS_MATCH; and a code fence left unclosed, which runs to the end of the file and swallows both what follows the section today and whatever is appended tomorrow. Use NotesApi.transformNote for edits that intentionally do any of these.

A target section that itself runs into an unterminated fence is not addressable at all — see NotesApi.readSection.

setSection.body

body: string

Replacement text for the section body.

setSection.heading

heading: string

Exact, case-sensitive heading text, without the leading #s.