Skip to content

fix(UseMutationResult): result type should be more specific to allow type narrowing #2620

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
TkDodo merged 1 commit into from
Sep 9, 2021
Merged

fix(UseMutationResult): result type should be more specific to allow type narrowing #2620

TkDodo merged 1 commit into from
Sep 9, 2021

Conversation

@raoufswe
Copy link
Contributor

@raoufswe raoufswe commented Aug 31, 2021 •
edited
Loading

fixes #2601

This PR refactors useMutationResult type to follow the same approach/logic of useQueryResult type.

@vercel
Copy link

vercel bot commented Aug 31, 2021 •
edited
Loading

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/tannerlinsley/react-query/3fsKtN53tVXMh2Ghi5kedvpg3JdZ
✅ Preview: https://react-query-git-fork-raoufswe-narrowusemut-68281a-tannerlinsley.vercel.app

@raoufswe raoufswe marked this pull request as draft August 31, 2021 16:41
@raoufswe raoufswe force-pushed the NarrowUseMutationResultType branch from 197ebaf to 9a95f9a Compare August 31, 2021 18:31
@raoufswe raoufswe force-pushed the NarrowUseMutationResultType branch from c916832 to 454875f Compare August 31, 2021 18:53
@codesandbox-ci
Copy link

codesandbox-ci bot commented Aug 31, 2021 •
edited
Loading

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 f4d9ce7:

Sandbox Source
tannerlinsley/react-query: basic Configuration
tannerlinsley/react-query: basic-typescript Configuration

@raoufswe raoufswe marked this pull request as ready for review August 31, 2021 19:03
TkDodo
TkDodo requested changes Aug 31, 2021
View reviewed changes
@raoufswe raoufswe force-pushed the NarrowUseMutationResultType branch from 3714a6b to 77e4108 Compare September 1, 2021 05:27
TkDodo
TkDodo requested changes Sep 2, 2021
View reviewed changes
@raoufswe raoufswe force-pushed the NarrowUseMutationResultType branch from b6255dd to 9c38dd4 Compare September 8, 2021 14:09
@TkDodo
Copy link
Collaborator

TkDodo commented Sep 8, 2021

hmm, for some reason, the type narrowing doesn't seem to work in the codesandbox preview builds. Can you have a look?

https://codesandbox.io/s/tannerlinsley-react-query-basic-typescript-forked-6zf7r?file=/src/index.tsx

@raoufswe raoufswe force-pushed the NarrowUseMutationResultType branch from fad9fcd to ca3a56a Compare September 8, 2021 15:01
@raoufswe
fix(UseMutationResult): MutationState type should be more specific, t…
f4d9ce7 
…o allow narrowing to match useQuery

fix(UseMutationResult): unify result type between core and react

fix(UseMutationResult): revert back mutateAsync to core/types

fix(mutationObserver): updateResult should declare a type then cast

fix(useMutation): revert some changes

fix(useMutation): revert uneeded changes

fix(useMutation): use Exclude instead of Omit to override mutate to return the correct union type

fix(useMutation): add Override to override mutate and return correct union type
@raoufswe raoufswe force-pushed the NarrowUseMutationResultType branch from 1bef391 to f4d9ce7 Compare September 8, 2021 16:36
@TkDodo TkDodo merged commit c956f1a into TanStack:master Sep 9, 2021
@tannerlinsley
Copy link
Member

tannerlinsley commented Sep 9, 2021

🎉 This PR is included in version 3.23.2 🎉

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

Reviewers

@TkDodo TkDodo TkDodo approved these changes

Assignees

No one assigned

Labels

released

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

MutationState type should be more specific, to allow narrowing to match useQuery

3 participants

@raoufswe @TkDodo @tannerlinsley