docs(editor): improve documentation for store class (#10949)

2026-02-12 20:38:52 +00:00 · 2025-03-18 07:57:58 +00:00
parent 99370573c8
commit ef00a158fc
10 changed files with 894 additions and 313 deletions
--- a/blocksuite/framework/store/src/model/doc.ts
+++ b/blocksuite/framework/store/src/model/doc.ts
@@ -29,20 +29,14 @@ export interface Doc {
     */
    historyUpdated: Subject<void>;
    /**
+     * @internal
     * This fires when the doc yBlock is updated.
     */
-    yBlockUpdated: Subject<
-      | {
-          type: 'add';
-          id: string;
-          isLocal: boolean;
-        }
-      | {
-          type: 'delete';
-          id: string;
-          isLocal: boolean;
-        }
-    >;
+    yBlockUpdated: Subject<{
+      type: 'add' | 'delete';
+      id: string;
+      isLocal: boolean;
+    }>;
  };

  get history(): Y.UndoManager;