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

docs(useQuery): change manual to enabled #1167

Merged
merged 1 commit into from
Oct 14, 2020
Merged

docs(useQuery): change manual to enabled #1167

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
4 changes: 2 additions & 2 deletions docs/src/pages/reference/useQuery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ const result = useQuery({
- `idle` if the query is idle. This only happens if a query is initialized with `enabled: false` and no initial data is available.
- `loading` if the query is in a "hard" loading state. This means there is no cached data and the query is currently fetching, eg `isFetching === true`
- `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
- `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query is in `manual` mode and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.
- `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.
- `isIdle: boolean`
- A derived boolean from the `status` variable above, provided for convenience.
- `isLoading: boolean`
Expand All @@ -176,7 +176,7 @@ const result = useQuery({
- Will be `true` if the query has been fetched after the component mounted.
- This property can be used to not show any previously cached data.
- `isFetching: boolean`
- Defaults to `true` so long as `manual` is set to `false`
- Defaults to `true` so long as `enabled` is set to `false`
- Will be `true` if the query is currently fetching, including background fetching.
- `failureCount: number`
- The failure count for the query.
Expand Down