🤖 Merge PR DefinitelyTyped#70823 [sharedb] Add doc.toSnapshot() by @…

…alecgibson
samantharamon · Oct 15, 2024 · 9c92d53 · 9c92d53
1 parent c2b6304
commit 9c92d53
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/types/sharedb/lib/sharedb.d.ts b/types/sharedb/lib/sharedb.d.ts
@@ -21,6 +21,7 @@ export interface Snapshot<T = any> {
     data?: T;
     m: SnapshotMeta | null;
 }
+export type IngestibleSnapshot<T = any> = Pick<Snapshot<T>, "v" | "type" | "data">;
 
 export interface SnapshotMeta {
     ctime: number;
@@ -174,7 +175,8 @@ export class Doc<T = any> extends TypedEmitter<DocEventMap<T>> {
     subscribe: (callback?: (err: Error) => void) => void;
     unsubscribe: (callback?: (err: Error) => void) => void;
 
-    ingestSnapshot(snapshot: Pick<Snapshot<T>, "v" | "type" | "data">, callback?: Callback): void;
+    toSnapshot(): IngestibleSnapshot<T>;
+    ingestSnapshot(snapshot: IngestibleSnapshot<T>, callback?: Callback): void;
     destroy(callback?: Callback): void;
     create(data: T, callback?: Callback): void;
     create(data: T, type?: string, callback?: Callback): void;

diff --git a/types/sharedb/sharedb-tests.ts b/types/sharedb/sharedb-tests.ts
@@ -290,6 +290,8 @@ doc.fetch((err) => {
 
 doc.create({ foo: true }, "http://sharejs.org/types/JSONv0");
 
+doc.ingestSnapshot(doc.toSnapshot());
+
 function startServer() {
     const server = http.createServer();