From b5fed6780cb293ffd148e1852d188ebe4de66b39 Mon Sep 17 00:00:00 2001 From: Denis Borovikov Date: Tue, 30 Jun 2020 14:13:02 -0600 Subject: [PATCH] Update README.md See https://github.com/tannerlinsley/react-query/issues/664 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8543bb7cbf6..6cbcca4f0b5 100644 --- a/README.md +++ b/README.md @@ -1959,7 +1959,7 @@ const promise = mutate(variables, { - Optional - This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive - Useful to perform optimistic updates to a resource in hopes that the mutation succeeds - - The value returned from this function will be passed to both the `onError` and `onSettled` functions and can be useful for rolling back optimistic updates in the event of a mutation failure. + - The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates. - `onSuccess: Function(data, variables) => Promise | undefined` - Optional - This function will fire when the mutation is successful and will be passed the mutation's result.