Skip to content
Hypomnema

Chain

A chain runs a sequence of steps, in order. It is QuickAdd’s Macro, limited to what touches reading and annotation.

type Step =
  | { type: "geste"; id: string }
  | { type: "command"; id: string }
  | { type: "script"; path: string; settings?: Record<string, string> }
  | { type: "wait"; ms: number };


interface ChainGeste extends GesteBase { kind: "chain"; steps: Step[]; }

Steps

Section titled “Steps”

A Gesture step runs another gesture. An Obsidian command step runs any Obsidian command, picked with Choose…, for instance Extract comments from this note (hypomnema:extract-note) or a command from another plugin. A Script step runs a .js file of your vault, with optional settings; see Scripts. A Pause (ms) step waits for a number of milliseconds, which helps when a previous command opens a note or a view that needs time to load.

Running

Section titled “Running”

Steps run one after the other. The chain stops at the first error, which is reported in a notice; the remaining steps do not run.

Values typed for {{VALUE:…}} variables in one step stay available to the following ones. If the first step asks for {{VALUE:project}}, a later extraction can use {{VALUE:project}} in its note name without asking again. Scripts can read and change these values through params.variables.

A chain cannot call itself, directly or through another chain or a group: if a cycle is detected, the run stops with a notice.

Example

Section titled “Example”

The method note End of reading builds a chain of two steps: extract the comments of the note, then run a script that adds the reading to a log and marks the note as read.