Skip to content

docs: mention query options strictly for useQuery #1609

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 3 commits into from
Jan 11, 2021
Merged

docs: mention query options strictly for useQuery #1609

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fd4a4a0
docs: mention query options strictly for useQuery
waptik Jan 9, 2021
0b2b5cd
Update QueryClient.md
waptik Jan 9, 2021
62abd0a
docs: fixed link to `useQuery` in `QueryClient`
waptik Jan 11, 2021
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
8 changes: 4 additions & 4 deletions docs/src/pages/reference/QueryClient.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ try {

**Options**

The options for `fetchQuery` are exactly the same as those of [`useQuery`](#usequery).
The options for `fetchQuery` are exactly the same as those of [`useQuery`](./useQuery), except the following: `enabled, refetchInterval, refetchIntervalInBackground, refetchOnWindowFocus, refetchOnReconnect, notifyOnChangeProps, notifyOnChangePropsExclusions, onSuccess, onError, onSettled, useErrorBoundary, select, suspense, keepPreviousData, placeholderData`; which are stictly for useQuery and useInfiniteQuery. You can check the [source code](https://github.com/tannerlinsley/react-query/blob/361935a12cec6f36d0bd6ba12e84136c405047c5/src/core/types.ts#L83) for more clarity.

**Returns**

Expand All @@ -109,7 +109,7 @@ try {

**Options**

The options for `fetchInfiniteQuery` are exactly the same as those of [`useInfiniteQuery`](#useinfinitequery).
The options for `fetchInfiniteQuery` are exactly the same as those of [`fetchQuery`](#queryclientfetchquery).

**Returns**

Expand All @@ -131,7 +131,7 @@ await queryClient.prefetchQuery(queryKey)

**Options**

The options for `prefetchQuery` are exactly the same as those of [`useQuery`](#usequery).
The options for `prefetchQuery` are exactly the same as those of [`fetchQuery`](#queryclientfetchquery).

**Returns**

Expand All @@ -148,7 +148,7 @@ await queryClient.prefetchInfiniteQuery(queryKey, queryFn)

**Options**

The options for `prefetchInfiniteQuery` are exactly the same as those of [`useInfiniteQuery`](#useinfinitequery).
The options for `prefetchInfiniteQuery` are exactly the same as those of [`fetchQuery`](#queryclientfetchquery).

**Returns**

Expand Down