Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(useMutation): clarify mutationFn option default #4837

Merged
merged 2 commits into from Jan 20, 2023
Merged

docs(useMutation): clarify mutationFn option default #4837

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b5556ae
docs(useMutation): clarify `mutationFn` option default
louis-young Jan 18, 2023
88f7e1e
Make optionality consistent with `useQuery` documentation
louis-young Jan 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/react/reference/useMutation.md
View file
Open in desktop
Expand Up @@ -43,7 +43,8 @@ mutate(variables, {
**Options**

- `mutationFn: (variables: TVariables) => Promise<TData>`
- **Required**
- Optional
- Defaults to the global mutation configuration `mutationFn`, which is `undefined` by default.
louis-young marked this conversation as resolved.
Show resolved Hide resolved
- A function that performs an asynchronous task and returns a promise.
- `variables` is an object that `mutate` will pass to your `mutationFn`
- `cacheTime: number | Infinity`
Expand Down