Add some docs to TaskMonitor interface

galaxyproject · Jul 8, 2024 · 7c8adb0 · 7c8adb0
1 parent eda9a21
commit 7c8adb0
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/client/src/composables/genericTaskMonitor.ts b/client/src/composables/genericTaskMonitor.ts
@@ -4,6 +4,10 @@ import { errorMessageAsString } from "@/utils/simple-error";
 
 const DEFAULT_POLL_DELAY = 10000;
 
+/**
+ * Represents a task monitor that can be used to wait for a background task to complete or
+ * check its status.
+ */
 export interface TaskMonitor {
     /**
      * Waits for a particular task ID to be completed.