docs: onSettled callbacks

TkDodo · TkDodo · commit 0ac0bb4269a1 · 2023-03-05T08:09:36.000+01:00
diff --git a/docs/react/reference/MutationCache.md b/docs/react/reference/MutationCache.md
@@ -36,14 +36,18 @@ Its available methods are:
   - Optional
   - This function will be called if some mutation is successful.
   - If you return a Promise from it, it will be awaited
+- `onSettled?: (data: unknown | undefined, error: unknown | null, variables: unknown, context: unknown, mutation: Mutation) => Promise<unknown> | unknown`
+  - Optional
+  - This function will be called if some mutation is settled (either successful or errored).
+  - If you return a Promise from it, it will be awaited
 - `onMutate?: (variables: unknown, mutation: Mutation) => Promise<unknown> | unknown`
   - Optional
   - This function will be called before some mutation executes.
   - If you return a Promise from it, it will be awaited
 
 ## Global callbacks
 
-The `onError`, `onSuccess` and `onMutate` callbacks on the MutationCache can be used to handle these events on a global level. They are different to `defaultOptions` provided to the QueryClient because:
+The `onError`, `onSuccess`, `onSettled` and `onMutate` callbacks on the MutationCache can be used to handle these events on a global level. They are different to `defaultOptions` provided to the QueryClient because:
 
 - `defaultOptions` can be overridden by each Mutation - the global callbacks will **always** be called.
 - `onMutate` does not allow returning a context value.
diff --git a/docs/react/reference/QueryCache.md b/docs/react/reference/QueryCache.md
@@ -16,7 +16,10 @@ const queryCache = new QueryCache({
   },
   onSuccess: data => {
     console.log(data)
-  }
+  },
+  onSettled: (data, error) => {
+    console.log(data, error)
+  },
 })
 
 const query = queryCache.find({ queryKey: ['posts'] })
@@ -37,10 +40,13 @@ Its available methods are:
 - `onSuccess?: (data: unknown, query: Query) => void`
   - Optional
   - This function will be called if some query is successful.
+- `onSettled?:` (data: unknown | undefined, error: unknown | null, query: Query) => void
+  - Optional
+  - This function will be called if some query is settled (either successful or errored).
 
 ## Global callbacks
 
-The `onError` and `onSuccess` callbacks on the QueryCache can be used to handle these events on a global level. They are different to `defaultOptions` provided to the QueryClient because:
+The `onError`, `onSuccess` and `onSettled` callbacks on the QueryCache can be used to handle these events on a global level. They are different to `defaultOptions` provided to the QueryClient because:
 - `defaultOptions` can be overridden by each Query - the global callbacks will **always** be called.
 - `defaultOptions` callbacks will be called once for each Observer, while the global callbacks will only be called once per Query.
 
