add documentation to snapshot method

UoaWDCC · Sep 16, 2024 · 16930c9 · 16930c9
1 parent 84ee169
commit 16930c9
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/server/src/data-layer/services/EventService.ts b/server/src/data-layer/services/EventService.ts
@@ -159,6 +159,11 @@ class EventService {
       .delete()
   }
 
+  /**
+   * Utility method for getting the snapshot of a document
+   *
+   * @param id the document id of the event to check, likely coming from a pagination cursor
+   */
   public async getEventSnapshot(id: string) {
     return await FirestoreCollections.events.doc(id).get()
   }