feat(react-query): add mutationOptions #8960
Conversation
github-actions
bot
added
documentation
Ubinquitous
force-pushed
the
feature/react-query-mutation-options
branch
from
5e14207 to
596896d
Compare
|
View your CI Pipeline Execution ↗ for commit ff15e5d.
☁️ Nx Cloud last updated this comment at |
| describe('mutationOptions', () => { | ||
| it('should not allow excess properties', () => { | ||
| return mutationOptions({ | ||
| mutationFn: () => Promise.resolve(5), | ||
| mutationKey: ['key'], | ||
| // @ts-expect-error this is a good error, because onMutates does not exist! | ||
| onMutates: 1000, | ||
| }) | ||
| }) | ||
|
|
||
| it('should infer types for callbacks', () => { | ||
| return mutationOptions({ | ||
| mutationFn: () => Promise.resolve(5), | ||
| mutationKey: ['key'], | ||
| onSuccess: (data) => { | ||
| expectTypeOf(data).toEqualTypeOf<number>() | ||
| }, | ||
| }) | ||
| }) | ||
| }) |
There was a problem hiding this comment.
In my opinion, Adding type testing about DataTag would be better. When adding DataTag for queryOptions there is lots of pull requests to fix its typescript error. so if we can guarantee mutationOption's type before releasing this new feature, mutationOptions, it would be better
There was a problem hiding this comment.
Thank you, I just added a test case for DataTag, but I can't test it locally because of an error in @tanstack/query-core. Could you please tell me how to run test in local? Or maybe I wrote some part of the code wrong?
Here is the error message:
There was a problem hiding this comment.
Are there any updates?
mutationOptions helps extracting mutation options into separate functions.