Link to the TypeScript type narrowing issue.

See: - microsoft/TypeScript#55239 (comment) - microsoft/TypeScript#4196
lgarron · Dec 10, 2024 · 3acfd00 · 3acfd00
1 parent ff4f4d8
commit 3acfd00
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/ArqBackupPlan.ts b/src/ArqBackupPlan.ts
@@ -35,7 +35,10 @@ export interface FinishedBackupActivityJSON
 }
 
 // Note: this should be `|` rather than `&`, but this is `&` due to TypeScript
-// limitations.
+// limitations. See:
+//
+// - https://github.com/microsoft/TypeScript/issues/55239#issuecomment-1662572540
+// - https://github.com/microsoft/TypeScript/issues/4196
 //
 // This means that `if (backupActivityJSON.message === "Idle")` unfortunately
 // cannot type narrow the type of backupActivityJSON from `BackupActivityJSON`