Skip to content

Update api.md #862

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

Merged
tannerlinsley merged 1 commit into from
Aug 20, 2020
Merged

Update api.md #862

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions docs/src/pages/docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,11 +297,14 @@ const promise = mutate(variables, {
- `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.
- `isIdle`, `isLoading`, `isSuccess`, `isError`: boolean variables derived from `status`
- `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.
- `reset: Function() => void`
- A function to clean the mutation internal state (i.e., it resets the mutation to its initial state).

## `queryCache`

Expand Down