From 7c8adb0a6baf9361027938547b574eb0de09e290 Mon Sep 17 00:00:00 2001
From: davelopez <46503462+davelopez@users.noreply.github.com>
Date: Mon, 8 Jul 2024 14:58:47 +0200
Subject: [PATCH] Add some docs to TaskMonitor interface

---
 client/src/composables/genericTaskMonitor.ts | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/client/src/composables/genericTaskMonitor.ts b/client/src/composables/genericTaskMonitor.ts
index c549b09f9ba7..69236f44dab8 100644
--- 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.