onBeforeRoute()
hook
The onBeforeRoute()
hook provides full control over routing.
It is usually used for internationalization:
We can also use it to implement a custom router.
⚠️For use cases other than i18n, open a GitHub ticket or reach out on Discord:onBeforeRoute()
is purposely limited but the limitations can be lifted in order to unlock new capabilities.
Example:
TypeScript
Don't omit
ReturnType<OnBeforeRouteSync>
otherwise TypeScript won't strictly check the return type.
See API >
pageContext
> Typescript for more information on how to extendpageContext
with your own extra properties.