Skip to content

Commit

Permalink
docs: update return for useQuery (#701)
Browse files Browse the repository at this point in the history
* docs: update return for useQuery

* add in return example
  • Loading branch information
MarceloAlves authored Jul 3, 2020
1 parent 10aaac0 commit 07c2a4f
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1729,6 +1729,7 @@ const {
isFetching,
failureCount,
refetch,
clear,
} = useQuery(queryKey, queryFn?, {
suspense,
queryKeySerializerFn,
Expand Down Expand Up @@ -1860,6 +1861,8 @@ const queryInfo = useQuery({
- A function to manually refetch the query if it is stale.
- To bypass the stale check, you can pass the `force: true` option and refetch it regardless of it's freshness
- If the query errors, the error will only be logged. If you want an error to be thrown, pass the `throwOnError: true` option
- `clear: Function() => void`
- A function to remove the query from the cache.
## `usePaginatedQuery`
Expand Down

0 comments on commit 07c2a4f

Please sign in to comment.