docs: describe RouterHistory

ngworker · Jan 5, 2023 · 4d5d839 · 4d5d839
1 parent 154ed54
commit 4d5d839
Showing 1 changed file with 5 additions and 0 deletions.
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
@@ -23,6 +23,11 @@ import {
   RouterSequence,
 } from './router-sequence';
 
+/**
+ * A history of router navigated sequences.
+ *
+ * The key is the navigation ID.
+ */
 type RouterHistory = Readonly<Record<number, RouterNavigatedSequence>>;
 interface RouterHistoryState {
   /**