refactor(router-store): Rename base router store state interface

ngrx · Aug 22, 2018 · 329b0b8 · 329b0b8
1 parent 58c8073
commit 329b0b8
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 15 deletions.
diff --git a/modules/router-store/src/index.ts b/modules/router-store/src/index.ts
@@ -28,5 +28,5 @@ export {
   RouterStateSerializer,
   DefaultRouterStateSerializer,
   SerializedRouterStateSnapshot,
-  SimpleRouterState,
+  BaseRouterStoreState,
 } from './serializer';
diff --git a/modules/router-store/src/router_store_module.ts b/modules/router-store/src/router_store_module.ts
@@ -18,7 +18,7 @@ import {
   DefaultRouterStateSerializer,
   RouterStateSerializer,
   SerializedRouterStateSnapshot,
-  SimpleRouterState,
+  BaseRouterStoreState,
 } from './serializer';
 
 /**
@@ -49,7 +49,7 @@ export const ROUTER_NAVIGATION = 'ROUTER_NAVIGATION';
 /**
  * Payload of ROUTER_NAVIGATION.
  */
-export type RouterNavigationPayload<T extends SimpleRouterState> = {
+export type RouterNavigationPayload<T extends BaseRouterStoreState> = {
   routerState: T;
   event: RoutesRecognized;
 };
@@ -58,7 +58,7 @@ export type RouterNavigationPayload<T extends SimpleRouterState> = {
  * An action dispatched when the router navigates.
  */
 export type RouterNavigationAction<
-  T extends SimpleRouterState = SerializedRouterStateSnapshot
+  T extends BaseRouterStoreState = SerializedRouterStateSnapshot
 > = {
   type: typeof ROUTER_NAVIGATION;
   payload: RouterNavigationPayload<T>;
@@ -72,7 +72,7 @@ export const ROUTER_CANCEL = 'ROUTER_CANCEL';
 /**
  * Payload of ROUTER_CANCEL.
  */
-export type RouterCancelPayload<T, V extends SimpleRouterState> = {
+export type RouterCancelPayload<T, V extends BaseRouterStoreState> = {
   routerState: V;
   storeState: T;
   event: NavigationCancel;
@@ -83,7 +83,7 @@ export type RouterCancelPayload<T, V extends SimpleRouterState> = {
  */
 export type RouterCancelAction<
   T,
-  V extends SimpleRouterState = SerializedRouterStateSnapshot
+  V extends BaseRouterStoreState = SerializedRouterStateSnapshot
 > = {
   type: typeof ROUTER_CANCEL;
   payload: RouterCancelPayload<T, V>;
@@ -97,7 +97,7 @@ export const ROUTER_ERROR = 'ROUTE_ERROR';
 /**
  * Payload of ROUTER_ERROR.
  */
-export type RouterErrorPayload<T, V extends SimpleRouterState> = {
+export type RouterErrorPayload<T, V extends BaseRouterStoreState> = {
   routerState: V;
   storeState: T;
   event: NavigationError;
@@ -108,7 +108,7 @@ export type RouterErrorPayload<T, V extends SimpleRouterState> = {
  */
 export type RouterErrorAction<
   T,
-  V extends SimpleRouterState = SerializedRouterStateSnapshot
+  V extends BaseRouterStoreState = SerializedRouterStateSnapshot
 > = {
   type: typeof ROUTER_ERROR;
   payload: RouterErrorPayload<T, V>;
@@ -139,7 +139,7 @@ export type RouterNavigatedAction = {
  */
 export type RouterAction<
   T,
-  V extends SimpleRouterState = SerializedRouterStateSnapshot
+  V extends BaseRouterStoreState = SerializedRouterStateSnapshot
 > =
   | RouterRequestAction
   | RouterNavigationAction<V>
@@ -148,14 +148,14 @@ export type RouterAction<
   | RouterNavigatedAction;
 
 export type RouterReducerState<
-  T extends SimpleRouterState = SerializedRouterStateSnapshot
+  T extends BaseRouterStoreState = SerializedRouterStateSnapshot
 > = {
   state: T;
   navigationId: number;
 };
 
 export function routerReducer<
-  T extends SimpleRouterState = SerializedRouterStateSnapshot
+  T extends BaseRouterStoreState = SerializedRouterStateSnapshot
 >(
   state: RouterReducerState<T> | undefined,
   action: RouterAction<any, T>

diff --git a/modules/router-store/src/serializer.ts b/modules/router-store/src/serializer.ts
@@ -2,19 +2,20 @@ import { ActivatedRouteSnapshot, RouterStateSnapshot } from '@angular/router';
 
 /**
  * Simple router state.
- * All custom router states / state serializers should have at least this property.
+ * All custom router states / state serializers should have at least
+ * the properties of this interface.
  */
-export interface SimpleRouterState {
+export interface BaseRouterStoreState {
   url: string;
 }
 
 export abstract class RouterStateSerializer<
-  T extends SimpleRouterState = SimpleRouterState
+  T extends BaseRouterStoreState = BaseRouterStoreState
 > {
   abstract serialize(routerState: RouterStateSnapshot): T;
 }
 
-export interface SerializedRouterStateSnapshot extends SimpleRouterState {
+export interface SerializedRouterStateSnapshot extends BaseRouterStoreState {
   root: ActivatedRouteSnapshot;
   url: string;
 }