Vizel API / core/src / VizelMarkdownSyncResult

Interface: VizelMarkdownSyncResult

Defined in: packages/core/src/types.ts:351

Result of Markdown synchronization.

Each framework-specific composable/hook/rune returns a result that structurally satisfies this interface (with framework-idiomatic reactive wrappers for markdown and isPending). The flush method is included so all frameworks expose the same surface.

Properties

flush

flush: () => void;

Defined in: packages/core/src/types.ts:362

Force any pending debounced markdown export to run immediately.

Returns

void

---

isPending

isPending: boolean;

Defined in: packages/core/src/types.ts:360

Whether markdown export is currently pending (debounced)

---

markdown

markdown: string;

Defined in: packages/core/src/types.ts:353

Current markdown content (reactive in framework wrappers)

---

setMarkdown

setMarkdown: (markdown) => void;

Defined in: packages/core/src/types.ts:358

Set markdown content to the editor. Automatically transforms diagram code blocks if transformDiagrams is enabled.

Parameters

Parameter	Type
markdown	string

Returns

void