Updates from Mutation Responses

When dealing with mutations that update objects on the server, it's common for the new object to be automatically returned in the response of the mutation. Instead of refetching any queries for that item and wasting a network call for data we already have, we can take advantage of the object returned by the mutation function and update the existing query with the new data immediately using the Query Client's setQueryData method:

1 const queryClient = useQueryClient()
2 
3 const mutation = useMutation(editTodo, {
4   onSuccess: data => queryClient.setQueryData(['todo', { id: 5 }], data),
5 })
6 
7 mutation.mutate({
8   id: 5,
9   name: 'Do the laundry',
10 })
11 
12 // The query below will be updated with the response from the
13 // successful mutation
14 const { status, data, error } = useQuery(['todo', { id: 5 }], fetchTodoByID)

You might want to tie the onSuccess logic into a reusable mutation, for that you can create a custom hook like this:

1 const useMutateTodo = () => {
2   const queryClient = useQueryClient()
3 
4   return useMutation(editTodo, {
5     // Notice the second argument is the variables object that the `mutate` function receives
6     onSuccess: (data, variables) => {
7       queryClient.setQueryData(['todo', { id: variables.id }], data)
8     },
9   })
10 }