fix(MutationOptions): improve the type of onMutate #2494
Merged
Conversation
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
set the return type of onMutate as Promise<TContext | undefined> instead of Promise<TContext> | Promise<undefined> to make it work with async functions
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/tannerlinsley/react-query/Bur2c4i2WKX8wMgBdyVwU2jVbUoe |
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 06a756f:
|
TkDodo
approved these changes
Jul 25, 2021
Collaborator
|
🎉 This PR is included in version 3.19.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Hey maintainers,
As I can see,
Promise<A> | Promise<B>is stricter thanPromise<A | B>and to the point that it won't work with async functions.In the case of
onMutate, because we currently define its type as, when we set an async function to it we'll receive a type error but it's very obscure and appears at another place.
So in this PR, I set the return type of
onMutatetoPromise<TContext | undefined>instead ofPromise<TContext> | Promise<undefined>to relax it to make it work with async functions.