diff --git a/docs/router-store/README.md b/docs/router-store/README.md index a3907c2366..4574848bc0 100644 --- a/docs/router-store/README.md +++ b/docs/router-store/README.md @@ -14,13 +14,23 @@ Install @ngrx/router-store from npm: ## Usage -During the navigation, before any guards or resolvers run, the router will dispatch a ROUTER_NAVIGATION action, which has the following signature: +During the navigation, before any guards or resolvers run, the router will dispatch a `ROUTER_NAVIGATION` action, which has the signature `RouterNavigationAction`: ```ts -export type RouterNavigationPayload = { - routerState: T, - event: RoutesRecognized -} +/** + * Payload of ROUTER_NAVIGATION. + */ +export declare type RouterNavigationPayload = { + routerState: T; + event: RoutesRecognized; +}; +/** + * An action dispatched when the router navigates. + */ +export declare type RouterNavigationAction = { + type: typeof ROUTER_NAVIGATION; + payload: RouterNavigationPayload; +}; ``` - Reducers receive this action. Throwing an error in the reducer cancels navigation.