Merge pull request #265 from webmasterkai/actionTypeAlt

rename UPDATE_LOCATION to CALL_HISTORY_METHOD

Author: timdorr

README.md

@@ -83,14 +83,14 @@ function MyComponent({ dispatch }) {
 }
 ```
 
-This will change the state, which will trigger a change in react-router. Additionally, if you want to respond to the path update action, just handle the `UPDATE_LOCATION` constant that we provide:
+This will change the state, which will trigger a change in react-router. Additionally, if you want to respond to the path update action, just handle the `CALL_HISTORY_METHOD` constant that we provide:
 
 ```js
-import { UPDATE_LOCATION } from 'react-router-redux'
+import { CALL_HISTORY_METHOD } from 'react-router-redux'
 
 function update(state, action) {
   switch(action.type) {
-  case UPDATE_LOCATION:
+  case CALL_HISTORY_METHOD:
     // do something here
   }
 }
@@ -142,7 +142,7 @@ A reducer function that keeps track of the router state. You must add this reduc
 
 **Warning:** It is a bad pattern to use `react-redux`'s `connect` decorator to map the state from this reducer to props on your `Route` components. This can lead to infinite loops and performance problems. `react-router` already provides this for you via `this.props.location`.
 
-#### `UPDATE_LOCATION`
+#### `CALL_HISTORY_METHOD`
 
 An action type that you can listen for in your reducers to be notified of route updates.
 

src/actions.js

@@ -3,11 +3,11 @@
  * If you're writing a middleware to watch for navigation events, be sure to
  * look for actions of this type.
  */
-export const UPDATE_LOCATION = '@@router/UPDATE_LOCATION'
+export const CALL_HISTORY_METHOD = '@@router/CALL_HISTORY_METHOD'
 
 function updateLocation(method) {
   return (...args) => ({
-    type: UPDATE_LOCATION,
+    type: CALL_HISTORY_METHOD,
     payload: { method, args }
   })
 }

src/index.js

@@ -2,7 +2,7 @@ export syncHistoryWithStore from './sync'
 export { LOCATION_CHANGE, routerReducer } from './reducer'
 
 export {
-  UPDATE_LOCATION,
+  CALL_HISTORY_METHOD,
   push, replace, go, goBack, goForward,
   routeActions
 } from './actions'

src/middleware.js

@@ -1,13 +1,13 @@
-import { UPDATE_LOCATION } from './actions'
+import { CALL_HISTORY_METHOD } from './actions'
 
 /**
- * This middleware captures UPDATE_LOCATION actions to redirect to the
+ * This middleware captures CALL_HISTORY_METHOD actions to redirect to the
  * provided history object. This will prevent these actions from reaching your
  * reducer or any middleware that comes after this one.
  */
 export default function routerMiddleware(history) {
   return () => next => action => {
-    if (action.type !== UPDATE_LOCATION) {
+    if (action.type !== CALL_HISTORY_METHOD) {
       return next(action)
     }
 

test/actions.spec.js

@@ -1,7 +1,7 @@
 import expect from 'expect'
 
 import {
-  UPDATE_LOCATION,
+  CALL_HISTORY_METHOD,
   push, replace, go, goBack, goForward
 } from '../src/actions'
 
@@ -10,15 +10,15 @@ describe('routeActions', () => {
   describe('push', () => {
     it('creates actions', () => {
       expect(push('/foo')).toEqual({
-        type: UPDATE_LOCATION,
+        type: CALL_HISTORY_METHOD,
         payload: {
           method: 'push',
           args: [ '/foo' ]
         }
       })
 
       expect(push({ pathname: '/foo', state: { the: 'state' } })).toEqual({
-        type: UPDATE_LOCATION,
+        type: CALL_HISTORY_METHOD,
         payload: {
           method: 'push',
           args: [ {
@@ -29,7 +29,7 @@ describe('routeActions', () => {
       })
 
       expect(push('/foo', 'baz', 123)).toEqual({
-        type: UPDATE_LOCATION,
+        type: CALL_HISTORY_METHOD,
         payload: {
           method: 'push',
           args: [ '/foo' , 'baz', 123 ]
@@ -41,15 +41,15 @@ describe('routeActions', () => {
   describe('replace', () => {
     it('creates actions', () => {
       expect(replace('/foo')).toEqual({
-        type: UPDATE_LOCATION,
+        type: CALL_HISTORY_METHOD,
         payload: {
           method: 'replace',
           args: [ '/foo' ]
         }
       })
 
       expect(replace({ pathname: '/foo', state: { the: 'state' } })).toEqual({
-        type: UPDATE_LOCATION,
+        type: CALL_HISTORY_METHOD,
         payload: {
           method: 'replace',
           args: [ {
@@ -64,7 +64,7 @@ describe('routeActions', () => {
   describe('go', () => {
     it('creates actions', () => {
       expect(go(1)).toEqual({
-        type: UPDATE_LOCATION,
+        type: CALL_HISTORY_METHOD,
         payload: {
           method: 'go',
           args: [ 1 ]
@@ -76,7 +76,7 @@ describe('routeActions', () => {
   describe('goBack', () => {
     it('creates actions', () => {
       expect(goBack()).toEqual({
-        type: UPDATE_LOCATION,
+        type: CALL_HISTORY_METHOD,
         payload: {
           method: 'goBack',
           args: []
@@ -88,7 +88,7 @@ describe('routeActions', () => {
   describe('goForward', () => {
     it('creates actions', () => {
       expect(goForward()).toEqual({
-        type: UPDATE_LOCATION,
+        type: CALL_HISTORY_METHOD,
         payload: {
           method: 'goForward',
           args: []