fix(typescript): Update getStaticPaths option to be fully typed#2963
Merged
Princesseuh merged 1 commit intomainfrom Mar 31, 2023
Merged
fix(typescript): Update getStaticPaths option to be fully typed#2963Princesseuh merged 1 commit intomainfrom
Princesseuh merged 1 commit intomainfrom
Conversation
✅ Deploy Preview for astro-docs-2 ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
delucis
approved these changes
Mar 30, 2023
Member
delucis
left a comment
There was a problem hiding this comment.
LGTM!
Can you use satisfies in a return type? (Couldn’t find it at all in the handbook… only in the announcement blog post.) Would look less weird if we were only annotating the result, but obviously that’s not helpful if you also want the parameters typed.
Member
Author
I believe you can, but in the case of |
1 task
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
3 participants
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 kind of changes does this PR include?
Description
This updates the
getStaticPathsexample in the TypeScript guide to be fully typed. The syntax does look weird because ofsatisfies, but it's important to show that this is the best way to typegetStaticPaths, because typing it normally (using: GetStaticPaths) breaksInferGetStaticParamsType(and its Props equivalent) since it works by inferring the return value (which typing it directly removes the ability to)