Skip to content

docs(query-react): Update links in useQuery documentation #11006

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

Open
ronny1020 wants to merge 1 commit into
base: v4
Choose a base branch
from
+6 −6
Open

docs(query-react): Update links in useQuery documentation #11006

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
12 changes: 6 additions & 6 deletions docs/framework/react/reference/useQuery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,20 +67,20 @@ const {
- `queryKey: unknown[]`
- **Required**
- The query key to use for this query.
- The query key will be hashed into a stable hash. See [Query Keys](../../../../framework/react/guides/query-keys) for more information.
- The query key will be hashed into a stable hash. See [Query Keys](../../../../docs/framework/react/guides/query-keys) for more information.
- The query will automatically update when this key changes (as long as `enabled` is not set to `false`).
- `queryFn: (context: QueryFunctionContext) => Promise<TData>`
- **Required, but only if no default query function has been defined** See [Default Query Function](../../../../framework/react/guides/default-query-function) for more information.
- **Required, but only if no default query function has been defined** See [Default Query Function](../../../../docs/framework/react/guides/default-query-function) for more information.
- The function that the query will use to request data.
- Receives a [QueryFunctionContext](../../../../framework/react/guides/query-functions#queryfunctioncontext)
- Receives a [QueryFunctionContext](../../../../docs/framework/react/guides/query-functions#queryfunctioncontext)
- Must return a promise that will either resolve data or throw an error. The data cannot be `undefined`.
- `enabled: boolean`
- Set this to `false` to disable this query from automatically running.
- Can be used for [Dependent Queries](../../../../framework/react/guides/dependent-queries).
- Can be used for [Dependent Queries](../../../../docs/framework/react/guides/dependent-queries).
- `networkMode: 'online' | 'always' | 'offlineFirst`
- optional
- defaults to `'online'`
- see [Network Mode](../../../../framework/react/guides/network-mode) for more information.
- see [Network Mode](../../../../docs/framework/react/guides/network-mode) for more information.
- `retry: boolean | number | (failureCount: number, error: TError) => boolean`
- If `false`, failed queries will not retry by default.
- If `true`, failed queries will retry infinitely.
Expand Down Expand Up @@ -238,7 +238,7 @@ const {
- `fetching`: Is `true` whenever the queryFn is executing, which includes initial `loading` as well as background refetches.
- `paused`: The query wanted to fetch, but has been `paused`.
- `idle`: The query is not fetching.
- see [Network Mode](../../../../framework/react/guides/network-mode) for more information.
- see [Network Mode](../../../../docs/framework/react/guides/network-mode) for more information.
- `isFetching: boolean`
- A derived boolean from the `fetchStatus` variable above, provided for convenience.
- `isPaused: boolean`
Expand Down