Skip to content

feat(react-query): backport v5 apis about infinite query #9334

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

Draft
wants to merge 4 commits into
base: v4
Choose a base branch
from
Draft

feat(react-query): backport v5 apis about infinite query #9334

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8e281a9
feat(react-query): backport v5 apis about infinite query
manudeli Jun 29, 2025
6866f7a
refactor(react-query): update infinite query tests and add type check…
manudeli Jul 16, 2025
edd7867
fix(react-query): clean up JSDoc formatting and improve type imports …
manudeli Jul 16, 2025
91170ba
refactor(query-core, react-query): standardize deprecated JSDoc comme…
manudeli Jul 16, 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
20 changes: 5 additions & 15 deletions packages/query-core/src/queryCache.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,16 +168,12 @@ export class QueryCache extends Subscribable<QueryCacheListener> {
find<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData>(
filters: QueryFilters,
): Query<TQueryFnData, TError, TData> | undefined
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
find<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData>(
queryKey: QueryKey,
filters?: OmitKeyof<QueryFilters, 'queryKey'>,
): Query<TQueryFnData, TError, TData> | undefined
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
find<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData>(
arg1: QueryKey | QueryFilters,
arg2?: OmitKeyof<QueryFilters, 'queryKey'>,
Expand All @@ -192,23 +188,17 @@ export class QueryCache extends Subscribable<QueryCacheListener> {
}

findAll(filters?: QueryFilters): Query[]
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
findAll(
queryKey?: QueryKey,
filters?: OmitKeyof<QueryFilters, 'queryKey'>,
): Query[]
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
findAll(
arg1?: QueryKey | QueryFilters,
arg2?: OmitKeyof<QueryFilters, 'queryKey'>,
): Query[]
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
findAll(
arg1?: QueryKey | QueryFilters,
arg2?: OmitKeyof<QueryFilters, 'queryKey'>,
Expand Down
136 changes: 34 additions & 102 deletions packages/query-core/src/queryClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,16 +113,12 @@ export class QueryClient {
}

isFetching(filters?: QueryFilters): number
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
isFetching(
queryKey?: QueryKey,
filters?: OmitKeyof<QueryFilters, 'queryKey'>,
): number
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
isFetching(arg1?: QueryKey | QueryFilters, arg2?: QueryFilters): number {
const [filters] = parseFilterArgs(arg1, arg2)
filters.fetchStatus = 'fetching'
Expand All @@ -136,16 +132,12 @@ export class QueryClient {
getQueryData<TQueryFnData = unknown>(
queryKey: QueryKey,
): TQueryFnData | undefined
/**
* @deprecated This method will accept only queryKey in the next major version.
*/
/** @deprecated This method will accept only queryKey in the next major version. */
getQueryData<TQueryFnData = unknown>(
queryKey: QueryKey,
filters: OmitKeyof<QueryFilters, 'queryKey'>,
): TQueryFnData | undefined
/**
* @deprecated This method will accept only queryKey in the next major version.
*/
/** @deprecated This method will accept only queryKey in the next major version. */
getQueryData<TQueryFnData = unknown>(
queryKey: QueryKey,
filters?: OmitKeyof<QueryFilters, 'queryKey'>,
Expand All @@ -164,9 +156,7 @@ export class QueryClient {
'queryKey'
>,
): Promise<TData>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
ensureQueryData<
TQueryFnData = unknown,
TError = unknown,
Expand All @@ -179,9 +169,7 @@ export class QueryClient {
'queryKey'
>,
): Promise<TData>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
ensureQueryData<
TQueryFnData = unknown,
TError = unknown,
Expand All @@ -195,9 +183,7 @@ export class QueryClient {
'queryKey' | 'queryFn'
>,
): Promise<TData>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
ensureQueryData<
TQueryFnData,
TError,
Expand Down Expand Up @@ -226,15 +212,11 @@ export class QueryClient {
getQueriesData<TQueryFnData = unknown>(
filters: QueryFilters,
): [QueryKey, TQueryFnData | undefined][]
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
getQueriesData<TQueryFnData = unknown>(
queryKey: QueryKey,
): [QueryKey, TQueryFnData | undefined][]
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
getQueriesData<TQueryFnData = unknown>(
queryKeyOrFilters: QueryKey | QueryFilters,
): [QueryKey, TQueryFnData | undefined][] {
Expand Down Expand Up @@ -271,17 +253,13 @@ export class QueryClient {
updater: Updater<TQueryFnData | undefined, TQueryFnData | undefined>,
options?: SetDataOptions,
): [QueryKey, TQueryFnData | undefined][]
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
setQueriesData<TQueryFnData>(
queryKey: QueryKey,
updater: Updater<TQueryFnData | undefined, TQueryFnData | undefined>,
options?: SetDataOptions,
): [QueryKey, TQueryFnData | undefined][]
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
setQueriesData<TQueryFnData>(
queryKeyOrFilters: QueryKey | QueryFilters,
updater: Updater<TQueryFnData | undefined, TQueryFnData | undefined>,
Expand All @@ -299,25 +277,19 @@ export class QueryClient {

getQueryState<TQueryFnData = unknown, TError = undefined>(
queryKey: QueryKey,
/**
* @deprecated This filters will be removed in the next major version.
*/
/** @deprecated This filters will be removed in the next major version. */
filters?: OmitKeyof<QueryFilters, 'queryKey'>,
): QueryState<TQueryFnData, TError> | undefined {
return this.queryCache.find<TQueryFnData, TError>(queryKey, filters)?.state
}

removeQueries(filters?: QueryFilters): void
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
removeQueries(
queryKey?: QueryKey,
filters?: OmitKeyof<QueryFilters, 'queryKey'>,
): void
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
removeQueries(
arg1?: QueryKey | QueryFilters,
arg2?: OmitKeyof<QueryFilters, 'queryKey'>,
Expand All @@ -335,17 +307,13 @@ export class QueryClient {
filters?: ResetQueryFilters<TPageData>,
options?: ResetOptions,
): Promise<void>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
resetQueries<TPageData = unknown>(
queryKey?: QueryKey,
filters?: OmitKeyof<ResetQueryFilters<TPageData>, 'queryKey'>,
options?: ResetOptions,
): Promise<void>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
resetQueries(
arg1?: QueryKey | ResetQueryFilters,
arg2?: OmitKeyof<ResetQueryFilters, 'queryKey'> | ResetOptions,
Expand All @@ -368,17 +336,13 @@ export class QueryClient {
}

cancelQueries(filters?: QueryFilters, options?: CancelOptions): Promise<void>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
cancelQueries(
queryKey?: QueryKey,
filters?: OmitKeyof<QueryFilters, 'queryKey'>,
options?: CancelOptions,
): Promise<void>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
cancelQueries(
arg1?: QueryKey | QueryFilters,
arg2?: OmitKeyof<QueryFilters, 'queryKey'> | CancelOptions,
Expand All @@ -403,17 +367,13 @@ export class QueryClient {
filters?: InvalidateQueryFilters<TPageData>,
options?: InvalidateOptions,
): Promise<void>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
invalidateQueries<TPageData = unknown>(
queryKey?: QueryKey,
filters?: OmitKeyof<InvalidateQueryFilters<TPageData>, 'queryKey'>,
options?: InvalidateOptions,
): Promise<void>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
invalidateQueries(
arg1?: QueryKey | InvalidateQueryFilters,
arg2?: OmitKeyof<InvalidateQueryFilters, 'queryKey'> | InvalidateOptions,
Expand Down Expand Up @@ -441,17 +401,13 @@ export class QueryClient {
filters?: RefetchQueryFilters<TPageData>,
options?: RefetchOptions,
): Promise<void>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
refetchQueries<TPageData = unknown>(
queryKey?: QueryKey,
filters?: OmitKeyof<RefetchQueryFilters<TPageData>, 'queryKey'>,
options?: RefetchOptions,
): Promise<void>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
refetchQueries(
arg1?: QueryKey | RefetchQueryFilters,
arg2?: OmitKeyof<RefetchQueryFilters, 'queryKey'> | RefetchOptions,
Expand Down Expand Up @@ -489,9 +445,7 @@ export class QueryClient {
>(
options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
): Promise<TData>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
fetchQuery<
TQueryFnData = unknown,
TError = unknown,
Expand All @@ -504,9 +458,7 @@ export class QueryClient {
'queryKey'
>,
): Promise<TData>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
fetchQuery<
TQueryFnData = unknown,
TError = unknown,
Expand All @@ -520,9 +472,7 @@ export class QueryClient {
'queryKey' | 'queryFn'
>,
): Promise<TData>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
fetchQuery<
TQueryFnData,
TError,
Expand Down Expand Up @@ -564,9 +514,7 @@ export class QueryClient {
>(
options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
): Promise<void>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
prefetchQuery<
TQueryFnData = unknown,
TError = unknown,
Expand All @@ -579,9 +527,7 @@ export class QueryClient {
'queryKey'
>,
): Promise<void>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
prefetchQuery<
TQueryFnData = unknown,
TError = unknown,
Expand All @@ -595,9 +541,7 @@ export class QueryClient {
'queryKey' | 'queryFn'
>,
): Promise<void>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
prefetchQuery<
TQueryFnData = unknown,
TError = unknown,
Expand Down Expand Up @@ -629,9 +573,7 @@ export class QueryClient {
>(
options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
): Promise<InfiniteData<TData>>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
fetchInfiniteQuery<
TQueryFnData = unknown,
TError = unknown,
Expand All @@ -644,9 +586,7 @@ export class QueryClient {
'queryKey'
>,
): Promise<InfiniteData<TData>>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
fetchInfiniteQuery<
TQueryFnData = unknown,
TError = unknown,
Expand All @@ -660,9 +600,7 @@ export class QueryClient {
'queryKey' | 'queryFn'
>,
): Promise<InfiniteData<TData>>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
fetchInfiniteQuery<
TQueryFnData,
TError,
Expand Down Expand Up @@ -700,9 +638,7 @@ export class QueryClient {
>(
options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
): Promise<void>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
prefetchInfiniteQuery<
TQueryFnData = unknown,
TError = unknown,
Expand All @@ -715,9 +651,7 @@ export class QueryClient {
'queryKey'
>,
): Promise<void>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
prefetchInfiniteQuery<
TQueryFnData = unknown,
TError = unknown,
Expand All @@ -731,9 +665,7 @@ export class QueryClient {
'queryKey' | 'queryFn'
>,
): Promise<void>
/**
* @deprecated This method should be used with only one object argument.
*/
/** @deprecated This method should be used with only one object argument. */
prefetchInfiniteQuery<
TQueryFnData,
TError,
Expand Down
Loading
Loading