[react-query] type error for infinity query defaults in QueryClient

[aizerin]

Describe the bug

I recently migrated from react-query v4 and this code now reports typescript error.

It does not accept values for infinite query.

const queryClient = new QueryClient({
  defaultOptions: {
    queries: {
      getNextPageParam: (lastPage: any) => lastPage?.nextCursor ?? undefined,
    },
  },
});

Type '{ getNextPageParam: (lastPage: any) => any; }' is not assignable to type 'OmitKeyof<QueryObserverOptions<unknown, Error, unknown, unknown, QueryKey, never>, "suspense" | "queryKey", "strictly">'.

Your minimal, reproducible example

https://codesandbox.io/p/sandbox/jtqm8f

Steps to reproduce

Just write this code

const queryClient = new QueryClient({
  defaultOptions: {
    queries: {
      getNextPageParam: (lastPage: any) => lastPage?.nextCursor ?? undefined,
    },
  },
});

Expected behavior

Typescript should be happy

How often does this bug happen?

Every time

Screenshots or Videos

No response

Platform

Any

Tanstack Query adapter

react-query

TanStack Query version

5.59.16

TypeScript version

5.6.3

Additional context

No response

[pawel-twardziak]

Hi @aizerin as far as I can see, getNextPageParam is not an option for QueryClient -> https://tanstack.com/query/latest/docs/reference/QueryClient.

You might wanna use one of these:

1. https://tanstack.com/query/latest/docs/framework/react/guides/migrating-to-react-query-3#infinitequeryobserver
2. https://tanstack.com/query/latest/docs/framework/react/guides/migrating-to-react-query-3#useinfinitequery-is-now-bi-directional

[aizerin]

I know, and I think this is wrong. Defaults for infinity query should be included in types (as they were in react-query v4).

It also works at runtime. getNextPageParam is used as the default for useInfinityQuery.

[pawel-twardziak]

Ok, then it is kinda inconsistency because the implementation differs from its typings.

[TkDodo]

we moved infinite query types into their own interface because getNextPageParam is now required for those:

query/packages/query-core/src/types.ts

Lines 410 to 425 in 18953be

	export interface InfiniteQueryObserverOptions<
	TQueryFnData = unknown,
	TError = DefaultError,
	TData = TQueryFnData,
	TQueryData = TQueryFnData,
	TQueryKey extends QueryKey = QueryKey,
	TPageParam = unknown,
	> extends QueryObserverOptions<
	TQueryFnData,
	TError,
	TData,
	InfiniteData<TQueryData, TPageParam>,
	TQueryKey,
	TPageParam
	>,
	InfiniteQueryPageParamsOptions<TQueryFnData, TPageParam> {}

It therefore doesn’t really make sense to set it globally (you’ll get an error on useInfiniteQuery if you don’t provide it) - same as for initialPageParam.

We could add it as Partial to the defaultOptions but how do you intend to use it on useInfiniteQuery then ?

[aizerin]

I have several infinity queries with the same getNextPageParam function. So I don't want to repeat it each time and just set it as default.