From 15a93307229121e6a8075162b74aa4348cbdb5c7 Mon Sep 17 00:00:00 2001
From: Brendan Chen <me@bchen.dev>
Date: Wed, 22 Jan 2025 22:29:01 -0800
Subject: [PATCH] add note about pruning behavior for ApiBasedRepositoryLoader

---
 src/loaders/ApiBasedRepositoryLoader.ts | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/loaders/ApiBasedRepositoryLoader.ts b/src/loaders/ApiBasedRepositoryLoader.ts
index f863cf6..af8fd66 100644
--- a/src/loaders/ApiBasedRepositoryLoader.ts
+++ b/src/loaders/ApiBasedRepositoryLoader.ts
@@ -8,6 +8,11 @@ export class ApiResponseError extends Error {
   }
 }
 
+/**
+ * Class which can load data into a repository from the
+ * Passio Go API. Supports automatic pruning of all data types
+ * which inherit from `IEntityWithId`.
+ */
 export class ApiBasedRepositoryLoader {
   supportedSystemIds = ["263"];
   baseUrl = "https://passiogo.com/mapGetData.php";