Skip to content
This repository was archived by the owner on Oct 26, 2018. It is now read-only.

Commit 952a570

Browse files
committed
Add unsubscribe docs
1 parent 64a3d65 commit 952a570

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,10 @@ Call this on the middleware returned from `syncHistory` to start the syncing pro
132132

133133
Supply an optional function `selectRouterState` to customize where to find the router state on your app state. It defaults to `state => state.routing`, so you would install the reducer under the name "routing". Feel free to change this to whatever you like.
134134

135+
#### `ReduxMiddleware.unsubscribe()`
136+
137+
Call this on the middleware returned from `syncHistory` to stop the syncing process set up by `syncHistoryToStore`.
138+
135139
#### `routeReducer`
136140

137141
A reducer function that keeps track of the router state. You must to add this reducer to your app reducers when creating the store.

0 commit comments

Comments
 (0)