Why is the subscribed option missing from useInfiniteQuery?

[SMhdAsadi]

In recent releases, a new subscribed option has been introduced for useQuery and useQueries. This addition has proven invaluable for detaching observers from the cache, particularly in React Native projects. A common use case arises in stack navigators, where new screens are pushed onto the stack but previous ones remain mounted. The subscribed option effectively prevents unnecessary observers in such scenarios, improving performance and resource management.

However, I noticed that the useInfiniteQuery hook doesn’t seem to support this option. Is there a specific reason for this omission, or has it simply been overlooked? If there are technical or design considerations behind this decision, I’d love to understand them. Alternatively, could adding subscribed to useInfiniteQuery be considered for future updates?

[TkDodo]

I just forgot to add it to the types. It should work at runtime, because both useQuery and useInfiniteQuery are built upon useBaseQuery, and that’s where the subscription happens.

It seems like the options of both hooks don’t both extend UseBaseQueryOptions, which is not ideal because judging by the naming, I though that’s what’s happening.

Ideally, we’d an a new interface that they both can extend, and that has the subscribed flag. Would you like to help implement that?

[SMhdAsadi]

I’d be happy to help implement this. I’ll take a closer look at the codebase and propose a solution in next days. If there are any specific guidelines or considerations I should keep in mind while working on this, please let me know.

[TkDodo]

thank you 🙏

I think you’d only need to look at the types.ts in query-core and react-query. The simplest “fix” is to just add the subscribed flag to the UseInfiniteQueryOptions interface, because that’s what useInfiniteQuery is using as input. But maybe there’s a way to consolidate the types a bit, not sure.