Vizel API / react/src / UseVizelVersionHistoryResult

Interface: UseVizelVersionHistoryResult

Defined in: packages/react/src/hooks/useVizelVersionHistory.ts:14

Version history hook result

Properties

clearVersions

clearVersions: () => Promise<void>;

Defined in: packages/react/src/hooks/useVizelVersionHistory.ts:30

Delete all versions

Returns

Promise<void>

---

deleteVersion

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

Defined in: packages/react/src/hooks/useVizelVersionHistory.ts:28

Delete a specific version

Parameters

Parameter	Type
versionId	string

Returns

Promise<void>

---

error

error: Error | null;

Defined in: packages/react/src/hooks/useVizelVersionHistory.ts:20

Last error that occurred

---

isLoading

isLoading: boolean;

Defined in: packages/react/src/hooks/useVizelVersionHistory.ts:18

Whether history is loading

---

loadVersions

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

Defined in: packages/react/src/hooks/useVizelVersionHistory.ts:26

Load all versions from storage

Returns

Promise<VizelVersionSnapshot[]>

---

restoreVersion

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

Defined in: packages/react/src/hooks/useVizelVersionHistory.ts:24

Restore document to a specific version

Parameters

Parameter	Type
versionId	string

Returns

Promise<boolean>

---

saveVersion

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

Defined in: packages/react/src/hooks/useVizelVersionHistory.ts:22

Save current document as a new version

Parameters

Parameter	Type
description?	string
author?	string

Returns

Promise< | VizelVersionSnapshot | null>

---

snapshots

snapshots: VizelVersionSnapshot[];

Defined in: packages/react/src/hooks/useVizelVersionHistory.ts:16

All stored snapshots (newest first)