Function hydrateRouter

hydrateRouter<T extends Router<any>>(
    router: T,
    to: To,
    options?: HydrateRouterOptions,
): T
Hydrates the router with the state provided by SSR.

To render SSR state, call hydrateRouter instead of the initial navigate call.

Note: SSR hydration can be enabled only for one router.
Type Parameters
- T extends Router<any>
  The hydrated router.
Parameters
- router: T
  The hydrated router.
- to: To
  The location to which the router was navigated during SSR.
- options: HydrateRouterOptions = {}
  Hydration options.
Returns T
The provided router.