[sharedb] Add emitter types to MilestoneDB

alecgibson · alecgibson · commit 8211f7f8eadb · 2024-07-02T17:22:27.000+01:00
The `MilestoneDB` [extends `EventEmitter`][1], and exposes these events: - [`'save'`][2] - [`'error'`][3] [1]: https://github.com/share/sharedb/blob/10ba551013138a0031fff632d587d3002e45b781/lib/milestone-db/index.js#L14 [2]: https://github.com/share/sharedb/blob/10ba551013138a0031fff632d587d3002e45b781/lib/milestone-db/memory.js#L40 [3]: https://github.com/share/sharedb/blob/10ba551013138a0031fff632d587d3002e45b781/lib/milestone-db/memory.js#L39
diff --git a/types/sharedb/index.d.ts b/types/sharedb/index.d.ts
@@ -221,7 +221,12 @@ declare namespace sharedb {
         private _removeStream(channel, stream): void;
     }
 
-    abstract class MilestoneDB {
+    interface MilestoneDBEventMap {
+        "error": (error: Error) => void;
+        "save": (collection: string, snapshot: Snapshot) => void;
+    }
+
+    abstract class MilestoneDB extends ShareDB.TypedEmitter<MilestoneDBEventMap> {
         close(callback?: BasicCallback): void;
         getMilestoneSnapshot(collection: string, id: string, version: number, callback?: BasicCallback): void;
         saveMilestoneSnapshot(collection: string, snapshot: Snapshot, callback?: BasicCallback): void;
diff --git a/types/sharedb/sharedb-tests.ts b/types/sharedb/sharedb-tests.ts
@@ -80,6 +80,11 @@ backend.on("someCustomEvent", (arg0: string, arg1: number) => {});
 backend.db.getOps("someCollection", "someId", null, null, {}, () => {});
 backend.db.getSnapshotBulk("someCollection", ["id1", "id2"], null, null, () => {});
 
+backend.milestoneDb.once("save", (collection, snapshot) => {
+    console.log(collection, snapshot.data);
+});
+backend.milestoneDb.on("error", (error) => console.error(error.message));
+
 console.log(backend.pubsub);
 console.log(backend.extraDbs);
 
