refactor(mutation): remove passing mutation context to mutation key g…

…etter
posva · Apr 5, 2024 · d16cf2d · d16cf2d
1 parent bc8a47f
commit d16cf2d
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 6 deletions.
diff --git a/playground/src/pages/ecom/item/[id].vue b/playground/src/pages/ecom/item/[id].vue
@@ -25,7 +25,7 @@ const itemAvailability = ref()
 watch(() => item.value?.availability, (value) => itemAvailability.value = value)
 
 const { mutate: bookProduct } = useMutation({
-  key: ['book-item'],
+  key: (product) => ['book-item', product.id],
   keys: (product) => [['items'], ['items', product.id]],
   mutation: async (product: ProductListItem) => {
     await delay(Math.random() * 1000 + 200)

diff --git a/src/use-mutation.test-d.ts b/src/use-mutation.test-d.ts
@@ -4,9 +4,8 @@ import { useMutation } from './use-mutation'
 it('types the parameters for the key', () => {
   useMutation({
     mutation: (_one: string) => Promise.resolve({ name: 'foo' }),
-    key(result, one) {
+    key(one) {
       expectTypeOf(one).toBeString()
-      expectTypeOf(result).toEqualTypeOf<{ name: string }>()
       return ['foo']
     },
   })

diff --git a/src/use-mutation.ts b/src/use-mutation.ts
@@ -5,9 +5,9 @@ import type { EntryKey } from './entry-options'
 import type { ErrorDefault } from './types-extension'
 import { type _Awaitable, noop } from './utils'
 
-type _MutationKey<TVars, TResult> =
+type _MutationKey<TVars> =
   | EntryKey
-  | ((data: TResult, vars: TVars) => EntryKey)
+  | ((vars: TVars) => EntryKey)
 
 // TODO: move to a plugin
 /**
@@ -73,7 +73,7 @@ export interface UseMutationOptions<
    */
   mutation: (vars: TVars, context: NoInfer<TContext>) => Promise<TResult>
 
-  key?: _MutationKey<TVars, TResult>
+  key?: _MutationKey<TVars>
 
   // TODO: move this to a plugin that calls invalidateEntry()
   /**