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

Commit ebe6806

Browse files
committed
Update the README
1 parent 3545a3e commit ebe6806

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

+18-6
Original file line numberDiff line numberDiff line change
@@ -154,15 +154,27 @@ piece of state must be named `routing`** (unless you provide a custom
154154

155155
### `UPDATE_PATH`
156156

157-
An action type that you can listen for in your reducers.
157+
An action type that you can listen for in your reducers to be notified of
158+
route updates.
158159

159-
### `updatePath(path, noRouterUpdate)`
160+
### `pushPath(path, state, { avoidRouterUpdate = false } = {})`
160161

161-
An action creator that you can use to update the current URL. Just
162-
pass it a string like `/foo/bar?param=5`.
162+
An action creator that you can use to update the current URL and update the
163+
browser history. Just pass it a string like `/foo/bar?param=5` as the
164+
`path` argument.
163165

164-
The `noRouterUpdate`, if `true`, will stop react-router from reacting
165-
to this and all future URL changes. Pass `false` to make it start
166+
You can optionally pass a state to this action creator to update the state of the
167+
current route.
168+
169+
The `avoidRouterUpdate`, if `true`, will stop react-router from reacting
170+
to this URL change. Pass `false` to make it start
166171
reacting again. This is useful if replaying snapshots while using the
167172
`forceRefresh` option of the browser history which forces full
168173
reloads. It's a rare edge case.
174+
175+
### `replacePath(path, state, { avoidRouterUpdate = false } = {})`
176+
177+
An action creator that you can use to replace the current URL without updating
178+
the browser history.
179+
180+
The `state` and the `avoidRouterUpdate` parameters work just like `pushPath`.

0 commit comments

Comments
 (0)