Vizel API / core/src / VizelVersionHistoryOptions

Interface: VizelVersionHistoryOptions

Defined in: packages/core/src/version-history.ts:42

Configuration options for version history

Properties

enabled?

optional enabled?: boolean;

Defined in: packages/core/src/version-history.ts:44

Enable version history (default: true)

---

key?

optional key?: string;

Defined in: packages/core/src/version-history.ts:50

Storage key for localStorage (default: 'vizel-versions')

---

maxVersions?

optional maxVersions?: number;

Defined in: packages/core/src/version-history.ts:46

Maximum number of versions to keep (default: 50)

---

onError?

optional onError?: (error) => void;

Defined in: packages/core/src/version-history.ts:57

Callback when an error occurs. The error may be a VizelError — narrow with isVizelError(error) to access the structured code field.

Parameters

Parameter	Type
error	Error

Returns

void

---

onRestore?

optional onRestore?: (snapshot) => void;

Defined in: packages/core/src/version-history.ts:59

Callback when a version is restored

Parameters

Parameter	Type
snapshot	VizelVersionSnapshot

Returns

void

---

onSave?

optional onSave?: (snapshot) => void;

Defined in: packages/core/src/version-history.ts:52

Callback when a version is saved

Parameters

Parameter	Type
snapshot	VizelVersionSnapshot

Returns

void

---

storage?

optional storage?: VizelVersionStorage;

Defined in: packages/core/src/version-history.ts:48

Storage backend (default: 'localStorage')