chore(indexation): add docs

editor-js · Nov 12, 2023 · 1cf80f4 · 1cf80f4
1 parent b364907
commit 1cf80f4
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/src/utils/EventBus/types/indexation.ts b/src/utils/EventBus/types/indexation.ts
@@ -1,6 +1,19 @@
+/**
+ * Alias for a document id
+ */
 type DocumentId = string;
+
+/**
+ * Alias for a block id
+ */
 type BlockId = string;
 
+/**
+ * Index for a block node
+ */
 export type BlockIndex = `${DocumentId}:${BlockId}`;
 
+/**
+ * Possible index types
+ */
 export type Index = BlockIndex;