fix(static-paths): improve error message for invalid path type in getStaticPaths#95887
Open
dev-shubham01 wants to merge 2 commits into
Open
fix(static-paths): improve error message for invalid path type in getStaticPaths#95887dev-shubham01 wants to merge 2 commits into
dev-shubham01 wants to merge 2 commits into
Conversation
| // For the object-provided path, we must make sure it specifies all | ||
| // required keys. | ||
| else { | ||
| else if (typeof entry !== 'object' || entry === null || Array.isArray(entry)) { |
Contributor
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What?
Added a type check in
buildPagesStaticPathsto catch when a non-string,non-object value (e.g. a number) is returned as a path entry in the
pathsarray from
getStaticPaths.Why?
When a developer forgets to convert a value to a string (e.g. returning a
number from pagination data), the error thrown was confusing and didn't
explain how to fix it. This change throws a clear, actionable error message
pointing to the exact problem.
How?
Added an
else ifbranch in thetoPrerender.forEachloop inpackages/next/src/build/static-paths/pages.tsthat checks if an entryis neither a string nor a valid object, and throws a descriptive error
with a hint to convert the value to a string.
Fixes #41281