docs: make returning a promise for optimistic updates more explicit (#…

…5485)
TanStack · Jun 7, 2023 · 6fb0807 · 6fb0807
1 parent b6000eb
commit 6fb0807
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/docs/react/guides/optimistic-updates.md b/docs/react/guides/optimistic-updates.md
@@ -15,7 +15,9 @@ This is the simpler variant, as it doesn't interact with the cache directly.
     mutationFn: (newTodo: string) => axios.post('/api/data', { text: newTodo }),
     // make sure to _return_ the Promise from the query invalidation
     // so that the mutation stays in `pending` state until the refetch is finished
-    onSettled: () => queryClient.invalidateQueries({ queryKey: ['todos'] }),
+    onSettled: async () => {
+      return await queryClient.invalidateQueries({ queryKey: ['todos'] })
+    },
   })
 ```
 [//]: # 'ExampleUI1'