docs: explain history key

ngworker · Jan 4, 2023 · 246a69f · 246a69f
1 parent 31271cb
commit 246a69f
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/packages/router-component-store/src/lib/router-history-store/router-history.store.ts b/packages/router-component-store/src/lib/router-history-store/router-history.store.ts
@@ -11,7 +11,9 @@ import { filter, Observable } from 'rxjs';
 
 interface RouterHistoryState {
   /**
-   * The history of all navigations.
+   * The history of all router navigation sequences.
+   *
+   * The key is the navigation ID.
    */
   readonly history: RouterNavigationHistory;
 }