@lexical/history 0.9.1 → 0.10.0

package/LexicalHistory.dev.js

@@ -266,6 +266,16 @@ function clearHistory(historyState) {
   historyState.redoStack = [];
   historyState.current = null;
 }
+/**
+ * Registers necessary listeners to manage undo/redo history stack and related editor commands.
+ * It returns `unregister` callback that cleans up all listeners and should be called on editor unmount.
+ * @param editor - The lexical editor.
+ * @param historyState - The history state, containing the current state and the undo/redo stack.
+ * @param delay - The time (in milliseconds) the editor should delay generating a new history stack,
+ * instead of merging the current changes with the current stack.
+ * @returns The listeners cleanup callback function.
+ */
+
 
 function registerHistory(editor, historyState, delay) {
   const getMergeAction = createMergeActionGetter(editor, delay);
@@ -332,6 +342,11 @@ function registerHistory(editor, historyState, delay) {
     unregisterUpdateListener();
   };
 }
+/**
+ * Creates an empty history state.
+ * @returns - The empty history state, as an object.
+ */
+
 function createEmptyHistoryState() {
   return {
     current: null,

package/index.d.ts

@@ -17,5 +17,18 @@ export declare type HistoryState = {
     redoStack: Array<HistoryStateEntry>;
     undoStack: Array<HistoryStateEntry>;
 };
+/**
+ * Registers necessary listeners to manage undo/redo history stack and related editor commands.
+ * It returns `unregister` callback that cleans up all listeners and should be called on editor unmount.
+ * @param editor - The lexical editor.
+ * @param historyState - The history state, containing the current state and the undo/redo stack.
+ * @param delay - The time (in milliseconds) the editor should delay generating a new history stack,
+ * instead of merging the current changes with the current stack.
+ * @returns The listeners cleanup callback function.
+ */
 export declare function registerHistory(editor: LexicalEditor, historyState: HistoryState, delay: number): () => void;
+/**
+ * Creates an empty history state.
+ * @returns - The empty history state, as an object.
+ */
 export declare function createEmptyHistoryState(): HistoryState;

package/package.json

@@ -8,13 +8,13 @@
     "history"
   ],
   "license": "MIT",
-  "version": "0.9.1",
+  "version": "0.10.0",
   "main": "LexicalHistory.js",
   "peerDependencies": {
-    "lexical": "0.9.1"
+    "lexical": "0.10.0"
   },
   "dependencies": {
-    "@lexical/utils": "0.9.1"
+    "@lexical/utils": "0.10.0"
   },
   "repository": {
     "type": "git",