Skip to content
This repository was archived by the owner on Sep 10, 2024. It is now read-only.

Latest commit

 

History

History
36 lines (23 loc) · 1.39 KB

README.md

File metadata and controls

36 lines (23 loc) · 1.39 KB

redux-hist Codeship Status for minodisk/redux-hist codecov

Middlewares / Actions / Reducers for Redux around History API.

Usage

API Reference

Actions

push(path: history.Path, state?: history.LocationState): ReduxActions.Action<{path: history.Path, state?: history.LocationState}>

replace(path: history.Path, state?: history.LocationState): ReduxActions.Action<{path: history.Path, state?: history.LocationState}>

go(diff: number): ReduxActions.Action<number>

goBack(): ReduxActions.Action<void>

goForward(): ReduxActions.Action<void>

Middlewares

createRouterMiddleware(router: Router, history: history.History): Redux.Middleware

createStaticRouterMiddleware(router: Router, pathname: string): Redux.Middleware

Reducers

reduceHistory(state: History, action: HistoryAction): History

reduceRouting(state: Routing, action: HistoryAction): Routing

Router

class Router

constructor()
router(path: pathToRegexp.Path): Key
exec(location: Pathname): Result

Related package