From d31f127982a60ac2bd2df611524d7caca8629664 Mon Sep 17 00:00:00 2001
From: RMidhunSuresh <hi@midhun.dev>
Date: Tue, 7 Jun 2022 13:28:56 +0530
Subject: [PATCH] Add explaining comment

---
 src/domain/navigation/Navigation.ts | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/src/domain/navigation/Navigation.ts b/src/domain/navigation/Navigation.ts
index c786d7a7..f5039732 100644
--- a/src/domain/navigation/Navigation.ts
+++ b/src/domain/navigation/Navigation.ts
@@ -19,6 +19,16 @@ import {BaseObservableValue, ObservableValue} from "../../observable/ObservableV
 
 type AllowsChild<T> = (parent: Segment<T> | undefined, child: Segment<T>) => boolean;
 
+/**
+ * OptionalValue is basically stating that if SegmentType[type] = true:
+ * - Allow this type to be optional
+ * - Give it a default value of undefined
+ * - Also allow it to be true
+ * This lets us do:
+ * const s: Segment<SegmentType> = new Segment("create-room");
+ * instead of
+ * const s: Segment<SegmentType> = new Segment("create-room", undefined);
+ */
 export type OptionalValue<T> = T extends true? [(undefined | true)?]: [T];
 
 export class Navigation<T extends object> {