Vizel API / svelte/src / CreateVizelVersionHistoryResult

Interface: CreateVizelVersionHistoryResult

Defined in: packages/svelte/src/runes/createVizelVersionHistory.svelte.ts:13

Version history rune result

Properties

clearVersions

clearVersions: () => Promise<void>;

Defined in: packages/svelte/src/runes/createVizelVersionHistory.svelte.ts:29

Delete all versions

Returns

Promise<void>

---

deleteVersion

deleteVersion: (versionId) => Promise<void>;

Defined in: packages/svelte/src/runes/createVizelVersionHistory.svelte.ts:27

Delete a specific version

Parameters

Parameter	Type
versionId	string

Returns

Promise<void>

---

error

readonly error: Error | null;

Defined in: packages/svelte/src/runes/createVizelVersionHistory.svelte.ts:19

Last error that occurred

---

isLoading

readonly isLoading: boolean;

Defined in: packages/svelte/src/runes/createVizelVersionHistory.svelte.ts:17

Whether history is loading

---

loadVersions

loadVersions: () => Promise<VizelVersionSnapshot[]>;

Defined in: packages/svelte/src/runes/createVizelVersionHistory.svelte.ts:25

Load all versions from storage

Returns

Promise<VizelVersionSnapshot[]>

---

restoreVersion

restoreVersion: (versionId) => Promise<boolean>;

Defined in: packages/svelte/src/runes/createVizelVersionHistory.svelte.ts:23

Restore document to a specific version

Parameters

Parameter	Type
versionId	string

Returns

Promise<boolean>

---

saveVersion

saveVersion: (description?, author?) => Promise<
  | VizelVersionSnapshot
| null>;

Defined in: packages/svelte/src/runes/createVizelVersionHistory.svelte.ts:21

Save current document as a new version

Parameters

Parameter	Type
description?	string
author?	string

Returns

Promise< | VizelVersionSnapshot | null>

---

snapshots

readonly snapshots: VizelVersionSnapshot[];

Defined in: packages/svelte/src/runes/createVizelVersionHistory.svelte.ts:15

All stored snapshots (newest first)