Vizel API / core/src / createVizelVersionHistoryHandlers

Function: createVizelVersionHistoryHandlers()

function createVizelVersionHistoryHandlers(
   getEditor, 
   options, 
   onStateChange
): object;

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

Creates version history handlers for an editor.

Parameters

Parameter	Type
getEditor	() => Editor | null | undefined
options	VizelVersionHistoryOptions
onStateChange	(state) => void

Returns

clearVersions

clearVersions: () => Promise<void>;

Delete all versions

Returns

Promise<void>

deleteVersion

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

Delete a specific version

Parameters

Parameter	Type
versionId	string

Returns

Promise<void>

loadVersions

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

Load all versions from storage

Returns

Promise<VizelVersionSnapshot[]>

restoreVersion

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

Restore document to a specific version

Parameters

Parameter	Type
versionId	string

Returns

Promise<boolean>

saveVersion

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

Save current document state as a new version

Parameters

Parameter	Type
description?	string
author?	string

Returns

Promise<VizelVersionSnapshot | null>

Example

const handlers = createVizelVersionHistoryHandlers(
  () => editor,
  { maxVersions: 20 },
  (state) => setState(prev => ({ ...prev, ...state }))
);

// Save a version
await handlers.saveVersion("Initial draft");

// List all versions
const versions = await handlers.loadVersions();

// Restore a version
await handlers.restoreVersion(versions[0].id);