Adds hooks required for use with Immutable.js or other wrappers

README.md

@@ -55,3 +55,12 @@ Inspired by `@ngrx/router-store`
     }
   }
   ```
+
+#### What if I use Immutable.js with my Redux store?
+
+When using a wrapper for your store's state, such as Immutable.js, you will need to change two things from the standard setup:
+
+1. Provide your own reducer function that will receive actions of type  `UPDATE_LOCATION` and return the payload merged into state.
+2. Pass a selector to access the payload state and convert it to a JS object via the `selectLocationFromState` option on `NgReduxRouter`'s `initialize()`.
+
+These two hooks will allow you to store the state that this library uses in whatever format or wrapper you would like.

src/index.ts

@@ -6,3 +6,7 @@ export {
   routerReducer,
   RouterAction
 } from './reducer';
+
+export {
+  UPDATE_LOCATION
+} from './actions';

src/reducer.ts

@@ -16,7 +16,3 @@ export function routerReducer(state: string = DefaultRouterState, action: Router
       return state;
   }
 }
-
-export function getLocationFromState(state) {
-  return state.router;
-}

src/router.ts

@@ -7,14 +7,14 @@ import { NgRedux } from 'ng2-redux';
 import { UPDATE_LOCATION } from './actions';
 import {
   RouterAction,
-  DefaultRouterState,
-  getLocationFromState
+  DefaultRouterState
 } from './reducer';
 
 @Injectable()
 export class NgReduxRouter {
   private isTimeTravelling: boolean;
   private currentLocation: string;
+  private defaultSelectLocationState = (state) => state.router;
 
   constructor(
     private location: Location,
@@ -23,9 +23,9 @@ export class NgReduxRouter {
     private applicationRef: ApplicationRef
   ) {}
 
-  initialize() {
+  initialize(selectLocationFromState = this.defaultSelectLocationState) {
     this.listenToRouterChanges();
-    this.listenToReduxChanges();
+    this.listenToReduxChanges(selectLocationFromState);
   }
 
   listenToRouterChanges() {
@@ -49,7 +49,7 @@ export class NgReduxRouter {
       .subscribe(handleLocationChange);
   }
 
-  listenToReduxChanges() {
+  listenToReduxChanges(selectLocationFromState) {
     const handleLocationChange = (location: string) => {
       if (this.currentLocation === location) {
         return;
@@ -60,14 +60,14 @@ export class NgReduxRouter {
       this.router
         .navigateByUrl(location)
         .then(() => {
-          // Apparently navigating by url doesnt trigger angulars change detection,
+          // Apparently navigating by url doesn't trigger Angular's change detection,
           // Need to do this manually then via ApplicationRef.
           this.applicationRef.tick();
         });
     }
 
     this.ngRedux
-      .select(state => getLocationFromState(state))
+      .select(state => selectLocationFromState(state))
       .distinctUntilChanged()
       .subscribe(handleLocationChange);
   }