Skip to content

docs(useQuery): remove suspense option in useQuery() v5 #6187

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
merged 1 commit into from
Oct 20, 2023
Merged

docs(useQuery): remove suspense option in useQuery() v5 #6187

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
6 changes: 0 additions & 6 deletions docs/react/reference/useQuery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ const {
select,
staleTime,
structuralSharing,
suspense,
throwOnError,
})
```
Expand Down Expand Up @@ -136,11 +135,6 @@ const {
- `select: (data: TData) => unknown`
- Optional
- This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.
- `suspense: boolean`
- Optional
- Set this to `true` to enable suspense mode.
- When `true`, `useQuery` will suspend when `status === 'pending'`
- When `true`, `useQuery` will throw runtime errors when `status === 'error'`
- `initialData: TData | () => TData`
- Optional
- If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
Expand Down