Include router.asPath caveats in docs #36876
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
idkwhojamesis
requested review from
timneutkens,
ijjk,
shuding,
styfle,
huozhi,
padmaia,
leerob and
balazsorban44
as code owners
|
Yay, first merged commit! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
As mentioned in #34197, which is linked in the current issue #36802, there are some caveats to using the
asPathfield onnext/routeras a prop, specifically when the page is rendered using SSR or automatic static optimization. I mention these caveats in both the automatic static optimization and useRouter pages.I chose not to mention it on the Rewrites page since the problem is not directly related to rewrites, although the problem most frequently occurs on rewritten pages.
Please let me know if something should be changed or checked in my edits. I have not personally encountered this problem and my additions are based on my interpretation of the discussions from the linked issues. I may also be forgetting other things as this is my first ever pull request.
Bug
fixes #numberasPathmismatch when usingrewritesfeature #36802