Skip to content

Update useMutation return types in readme #162

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.

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

Merged
merged 2 commits into from
Feb 27, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2074,11 +2074,12 @@ const promise = mutate(variables, {
- The mutation function you can call with variables to trigger the mutation and optionally override the original mutation options.
- `status: String`
- Will be:
- `idle` initial status prior to the mutation function executing.
- `loading` if the mutation is currently executing.
- `error` if the last mutation attempt resulted in an error.
- `success' if the last mutation attempt was successful.
- `data: null | Any`
- Defaults to `null`
- `data: undefined | Any`
- Defaults to `undefined`
- The last successfully resolved data for the query.
- `error: null | Error`
- The error object for the query, if an error was encountered.
Expand Down