Skip to content

Commit 160d1ac

Browse files
authored
docs(api): change manual to isEnabled (#1166)
1 parent 5bfd7af commit 160d1ac

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/src/pages/docs/api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ const queryInfo = useQuery({
157157
- `idle` if the query is idle. This only happens if a query is initialized with `enabled: false` and no initial data is available.
158158
- `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`
159159
- `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
160-
- `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.
160+
- `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.
161161
- `isIdle: Boolean`
162162
- A derived boolean from the `status` variable above, provided for convenience.
163163
- `isLoading: Boolean`
@@ -180,7 +180,7 @@ const queryInfo = useQuery({
180180
- Will be `true` if the query has been fetched after the component mounted.
181181
- This property can be used to not show any previously cached data.
182182
- `isFetching: Boolean`
183-
- Defaults to `true` so long as `manual` is set to `false`
183+
- Defaults to `true` so long as `enabled` is set to `false`
184184
- Will be `true` if the query is currently fetching, including background fetching.
185185
- `failureCount: Integer`
186186
- The failure count for the query.

0 commit comments

Comments
 (0)