Add jsdoc comment to isResidualResult

DataDog · Sep 11, 2024 · b61387f · b61387f
1 parent 5cf21eb
commit b61387f
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/commands/synthetics/batch.ts b/src/commands/synthetics/batch.ts
@@ -299,6 +299,12 @@ const getPollResultMap = async (api: APIHelper, resultIds: string[]) => {
   }
 }
 
+/**
+ * A residual result is either:
+ * - Still incomplete (from the poll results POV): report it with incomplete data and a warning. 
+ * - Still in progress (from the batch POV): it was never emitted.  
+ * - A timed out retry.
+ */
 const isResidualResult = (
   result: BaseResultInBatch,
   emittedResultIds: Set<string>,