chore: rename to onMutateResult

Author: joshuaellis

docs/framework/angular/guides/mutations.md

@@ -93,17 +93,17 @@ mutation = injectMutation(() => ({
   onMutate: (variables, context) => {
     // A mutation is about to happen!
 
-    // Optionally return a scope containing data to use when for example rolling back
+    // Optionally return a result containing data to use when for example rolling back
     return { id: 1 }
   },
-  onError: (error, variables, scope, context) => {
+  onError: (error, variables, onMutateResult, context) => {
     // An error happened!
-    console.log(`rolling back optimistic update with id ${scope.id}`)
+    console.log(`rolling back optimistic update with id ${onMutateResult.id}`)
   },
-  onSuccess: (data, variables, scope, context) => {
+  onSuccess: (data, variables, onMutateResult, context) => {
     // Boom baby!
   },
-  onSettled: (data, error, variables, scope, context) => {
+  onSettled: (data, error, variables, onMutateResult, context) => {
     // Error or success... doesn't matter!
   },
 }))
@@ -130,25 +130,25 @@ mutation = injectMutation(() => ({
 ```ts
 mutation = injectMutation(() => ({
   mutationFn: addTodo,
-  onSuccess: (data, variables, scope, context) => {
+  onSuccess: (data, variables, onMutateResult, context) => {
     // I will fire first
   },
-  onError: (error, variables, scope, context) => {
+  onError: (error, variables, onMutateResult, context) => {
     // I will fire first
   },
-  onSettled: (data, error, variables, scope, context) => {
+  onSettled: (data, error, variables, onMutateResult, context) => {
     // I will fire first
   },
 }))
 
 mutation.mutate(todo, {
-  onSuccess: (data, variables, scope, context) => {
+  onSuccess: (data, variables, onMutateResult, context) => {
     // I will fire second!
   },
-  onError: (error, variables, scope, context) => {
+  onError: (error, variables, onMutateResult, context) => {
     // I will fire second!
   },
-  onSettled: (data, error, variables, scope, context) => {
+  onSettled: (data, error, variables, onMutateResult, context) => {
     // I will fire second!
   },
 })
@@ -161,15 +161,15 @@ mutation.mutate(todo, {
 export class Example {
   mutation = injectMutation(() => ({
     mutationFn: addTodo,
-    onSuccess: (data, variables, scope, context) => {
+    onSuccess: (data, variables, onMutateResult, context) => {
       // Will be called 3 times
     },
   }))
 
   doMutations() {
     ;['Todo 1', 'Todo 2', 'Todo 3'].forEach((todo) => {
       this.mutation.mutate(todo, {
-        onSuccess: (data, variables, scope, context) => {
+        onSuccess: (data, variables, onMutateResult, context) => {
           // Will execute only once, for the last mutation (Todo 3),
           // regardless which mutation resolves first
         },
@@ -224,19 +224,21 @@ queryClient.setMutationDefaults(['addTodo'], {
     // Add optimistic todo to todos list
     context.client.setQueryData(['todos'], (old) => [...old, optimisticTodo])
 
-    // Return scope with the optimistic todo
+    // Return result with the optimistic todo
     return { optimisticTodo }
   },
-  onSuccess: (result, variables, scope, context) => {
+  onSuccess: (result, variables, onMutateResult, context) => {
     // Replace optimistic todo in the todos list with the result
     context.client.setQueryData(['todos'], (old) =>
-      old.map((todo) => (todo.id === scope.optimisticTodo.id ? result : todo)),
+      old.map((todo) =>
+        todo.id === onMutateResult.optimisticTodo.id ? result : todo,
+      ),
     )
   },
-  onError: (error, variables, scope, context) => {
+  onError: (error, variables, onMutateResult, context) => {
     // Remove optimistic todo from the todos list
     context.client.setQueryData(['todos'], (old) =>
-      old.filter((todo) => todo.id !== scope.optimisticTodo.id),
+      old.filter((todo) => todo.id !== onMutateResult.optimisticTodo.id),
     )
   },
   retry: 3,

docs/framework/angular/guides/optimistic-updates.md

@@ -98,16 +98,16 @@ updateTodo = injectMutation(() => ({
     // Optimistically update to the new value
     context.client.setQueryData(['todos'], (old) => [...old, newTodo])
 
-    // Return a scope object with the snapshotted value
+    // Return a result object with the snapshotted value
     return { previousTodos }
   },
   // If the mutation fails,
-  // use the scope returned from onMutate to roll back
-  onError: (err, newTodo, scope, context) => {
-    context.client.setQueryData(['todos'], scope.previousTodos)
+  // use the result returned from onMutate to roll back
+  onError: (err, newTodo, onMutateResult, context) => {
+    context.client.setQueryData(['todos'], onMutateResult.previousTodos)
   },
   // Always refetch after error or success:
-  onSettled: (data, error, variables, scope, context) => {
+  onSettled: (data, error, variables, onMutateResult, context) => {
     context.client.invalidateQueries({ queryKey: ['todos'] })
   },
 }))
@@ -133,15 +133,18 @@ updateTodo = injectMutation(() => ({
     // Optimistically update to the new value
     context.client.setQueryData(['todos', newTodo.id], newTodo)
 
-    // Return a scope with the previous and new todo
+    // Return a result with the previous and new todo
     return { previousTodo, newTodo }
   },
-  // If the mutation fails, use the scope we returned above
-  onError: (err, newTodo, scope, context) => {
-    context.client.setQueryData(['todos', scope.newTodo.id], scope.previousTodo)
+  // If the mutation fails, use the result we returned above
+  onError: (err, newTodo, onMutateResult, context) => {
+    context.client.setQueryData(
+      ['todos', onMutateResult.newTodo.id],
+      onMutateResult.previousTodo,
+    )
   },
   // Always refetch after error or success:
-  onSettled: (newTodo, error, variables, scope, context) => {
+  onSettled: (newTodo, error, variables, onMutateResult, context) => {
     context.client.invalidateQueries({ queryKey: ['todos', newTodo.id] })
   },
 }))
@@ -154,7 +157,7 @@ updateTodo = injectMutation(() => ({
 injectMutation({
   mutationFn: updateTodo,
   // ...
-  onSettled: (newTodo, error, variables, scope) => {
+  onSettled: (newTodo, error, variables, onMutateResult, context) => {
     if (error) {
       // do something
     }

docs/framework/angular/reference/functions/injectmutation.md

@@ -6,10 +6,10 @@ title: injectMutation
 # Function: injectMutation()
 
 ```ts
-function injectMutation<TData, TError, TVariables, TScope>(
+function injectMutation<TData, TError, TVariables, TOnMutateResult>(
   injectMutationFn,
   options?,
-): CreateMutationResult<TData, TError, TVariables, TScope>
+): CreateMutationResult<TData, TError, TVariables, TOnMutateResult>
 ```
 
 Injects a mutation: an imperative function that can be invoked which typically performs server side effects.
@@ -24,13 +24,13 @@ Unlike queries, mutations are not run automatically.
 
 • **TVariables** = `void`
 
-• **TScope** = `unknown`
+• **TOnMutateResult** = `unknown`
 
 ## Parameters
 
 ### injectMutationFn
 
-() => [`CreateMutationOptions`](../../interfaces/createmutationoptions.md)\<`TData`, `TError`, `TVariables`, `TScope`\>
+() => [`CreateMutationOptions`](../../interfaces/createmutationoptions.md)\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>
 
 A function that returns mutation options.
 
@@ -42,7 +42,7 @@ Additional configuration
 
 ## Returns
 
-[`CreateMutationResult`](../../type-aliases/createmutationresult.md)\<`TData`, `TError`, `TVariables`, `TScope`\>
+[`CreateMutationResult`](../../type-aliases/createmutationresult.md)\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>
 
 The mutation.
 

docs/framework/angular/reference/functions/mutationoptions.md

@@ -6,9 +6,9 @@ title: mutationOptions
 # Function: mutationOptions()
 
 ```ts
-function mutationOptions<TData, TError, TVariables, TScope>(
+function mutationOptions<TData, TError, TVariables, TOnMutateResult>(
   options,
-): CreateMutationOptions<TData, TError, TVariables, TScope>
+): CreateMutationOptions<TData, TError, TVariables, TOnMutateResult>
 ```
 
 Allows to share and re-use mutation options in a type-safe way.
@@ -46,19 +46,19 @@ mutation.mutate({ title: 'New Title' })
 
 • **TVariables** = `void`
 
-• **TScope** = `unknown`
+• **TOnMutateResult** = `unknown`
 
 ## Parameters
 
 ### options
 
-`MutationObserverOptions`\<`TData`, `TError`, `TVariables`, `TScope`\>
+`MutationObserverOptions`\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>
 
 The mutation options.
 
 ## Returns
 
-[`CreateMutationOptions`](../../interfaces/createmutationoptions.md)\<`TData`, `TError`, `TVariables`, `TScope`\>
+[`CreateMutationOptions`](../../interfaces/createmutationoptions.md)\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>
 
 Mutation options.
 

docs/framework/angular/reference/interfaces/basemutationnarrowing.md

@@ -3,7 +3,7 @@ id: BaseMutationNarrowing
 title: BaseMutationNarrowing
 ---
 
-# Interface: BaseMutationNarrowing\<TData, TError, TVariables, TScope\>
+# Interface: BaseMutationNarrowing\<TData, TError, TVariables, TOnMutateResult\>
 
 ## Type Parameters
 
@@ -13,7 +13,7 @@ title: BaseMutationNarrowing
 
 • **TVariables** = `unknown`
 
-• **TScope** = `unknown`
+• **TOnMutateResult** = `unknown`
 
 ## Properties
 
@@ -25,12 +25,19 @@ isError: SignalFunction<
     TData,
     TError,
     TVariables,
-    TScope,
+    TOnMutateResult,
     Override<
-      MutationObserverErrorResult<TData, TError, TVariables, TScope>,
-      { mutate: CreateMutateFunction<TData, TError, TVariables, TScope> }
+      MutationObserverErrorResult<TData, TError, TVariables, TOnMutateResult>,
+      {
+        mutate: CreateMutateFunction<TData, TError, TVariables, TOnMutateResult>
+      }
     > & {
-      mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TScope>
+      mutateAsync: CreateMutateAsyncFunction<
+        TData,
+        TError,
+        TVariables,
+        TOnMutateResult
+      >
     }
   >
 >
@@ -50,12 +57,19 @@ isIdle: SignalFunction<
     TData,
     TError,
     TVariables,
-    TScope,
+    TOnMutateResult,
     Override<
-      MutationObserverIdleResult<TData, TError, TVariables, TScope>,
-      { mutate: CreateMutateFunction<TData, TError, TVariables, TScope> }
+      MutationObserverIdleResult<TData, TError, TVariables, TOnMutateResult>,
+      {
+        mutate: CreateMutateFunction<TData, TError, TVariables, TOnMutateResult>
+      }
     > & {
-      mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TScope>
+      mutateAsync: CreateMutateAsyncFunction<
+        TData,
+        TError,
+        TVariables,
+        TOnMutateResult
+      >
     }
   >
 >
@@ -75,12 +89,19 @@ isPending: SignalFunction<
     TData,
     TError,
     TVariables,
-    TScope,
+    TOnMutateResult,
     Override<
-      MutationObserverLoadingResult<TData, TError, TVariables, TScope>,
-      { mutate: CreateMutateFunction<TData, TError, TVariables, TScope> }
+      MutationObserverLoadingResult<TData, TError, TVariables, TOnMutateResult>,
+      {
+        mutate: CreateMutateFunction<TData, TError, TVariables, TOnMutateResult>
+      }
     > & {
-      mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TScope>
+      mutateAsync: CreateMutateAsyncFunction<
+        TData,
+        TError,
+        TVariables,
+        TOnMutateResult
+      >
     }
   >
 >
@@ -100,12 +121,19 @@ isSuccess: SignalFunction<
     TData,
     TError,
     TVariables,
-    TScope,
+    TOnMutateResult,
     Override<
-      MutationObserverSuccessResult<TData, TError, TVariables, TScope>,
-      { mutate: CreateMutateFunction<TData, TError, TVariables, TScope> }
+      MutationObserverSuccessResult<TData, TError, TVariables, TOnMutateResult>,
+      {
+        mutate: CreateMutateFunction<TData, TError, TVariables, TOnMutateResult>
+      }
     > & {
-      mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TScope>
+      mutateAsync: CreateMutateAsyncFunction<
+        TData,
+        TError,
+        TVariables,
+        TOnMutateResult
+      >
     }
   >
 >

docs/framework/angular/reference/interfaces/createmutationoptions.md

@@ -3,11 +3,11 @@ id: CreateMutationOptions
 title: CreateMutationOptions
 ---
 
-# Interface: CreateMutationOptions\<TData, TError, TVariables, TScope\>
+# Interface: CreateMutationOptions\<TData, TError, TVariables, TOnMutateResult\>
 
 ## Extends
 
-- `OmitKeyof`\<`MutationObserverOptions`\<`TData`, `TError`, `TVariables`, `TScope`\>, `"_defaulted"`\>
+- `OmitKeyof`\<`MutationObserverOptions`\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>, `"_defaulted"`\>
 
 ## Type Parameters
 
@@ -17,4 +17,4 @@ title: CreateMutationOptions
 
 • **TVariables** = `void`
 
-• **TScope** = `unknown`
+• **TOnMutateResult** = `unknown`