fix(types): navigate doesn't return anything #38590
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
gatsbot
bot
added
the
status: triage needed
pieh
added
topic: TypeScript
pieh
approved these changes
Jan 3, 2024
2 tasks
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.
Description
Gatsby's navigate() function uses @reach/router's navigate() function, but the latter returns a Promise, while the former does not. This PR updates the type of the gatsby's navigate() function to accurately reflect this.
Documentation
The documentation is already correct:
https://www.gatsbyjs.org/docs/gatsby-link/#how-to-use-the-navigate-helper-function
https://reach.tech/router/api/navigate
Related Issues
fixes #22151 (which has gone stale)
related to issue #25123
related to pull request #24214