Skip to content

fix(react-query): mark deprecated jsdoc on suspense option of UseQueryOptions #9360

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 2 commits into from
Jul 4, 2025
Merged

fix(react-query): mark deprecated jsdoc on suspense option of UseQueryOptions #9360

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc7481b
feat(react-query): add `suspense` option to UseQueryOptions with depr…
manudeli Jul 4, 2025
bb4cd42
chore: update
manudeli Jul 4, 2025
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
10 changes: 9 additions & 1 deletion packages/react-query/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,15 @@ export interface UseQueryOptions<
TData,
TQueryFnData,
TQueryKey
> {}
> {
/**
* If set to `true`, the query will suspend when `status === 'loading'`
* and throw errors when `status === 'error'`.
* Defaults to `false`.
* @deprecated This option will be removed in the next major version.
*/
suspense?: boolean
}

export type UseSuspenseQueryOptions<
TQueryFnData = unknown,
Expand Down
Loading