V3 Umbrella Issue

[tannerlinsley]

Below are the official breaking changes and features for v3. If you have a feature request or idea, please use the Discussions tab to open a new discussion about that idea.

Global:

• Remove usePaginatedQuery.
• Remove ReactQueryConfig.shared as it only contains one value.
• Change QueryConfig.enabled type to boolean but keep behavior.
• Change query key type to match with documentation (string | any[]).
• Remove react-query.mjs in favor of unbundled ESM files.
• QueryCache and Query async methods should throw and hook methods should not.

Query:

• Rename clear() to remove().
• Remove refetch() in favor of QueryObserver.refetch(). The refetch() method on Query is redundant as the functionality is the same as fetch().
• Remove subscribe() as it is only used in the tests.
• Remove fetchMoreVariable argument from fetchMore() in favor of FetchMoreOptions.

QueryCache:

• Remove global query cache.
• Remove makeQueryCache in favor of new QueryCache().
• Remove resetErrorBoundaries().
• Remove prefetch() options (force/throwOnError).
• Rename prefetchQuery() to fetchQuery().
• Change isFetching to isFetching() and do not store state.
• Remove true predicate option from getQueries() in favor of undefined.

ReactQueryCacheProvider

• Make usage required. (Non-breaking, documented)
• Do not create query cache automatically.

QueryObserver:

• Rename clear() to remove(). (Non-breaking deprecation)

Query Config:

• Remove forceFetchOnMount.
• Change refetchOnMount false behavior to disable refetch on mount for that specific hook

[smashercosmo]

Would be nice to address this somehow in v3 #669

[Danscap]

@tannerlinsley is there any support for class components for react? not directly but rendering a functional component with query hooks into a class component.

[kamranayub]

For V3, I'd propose allowing extending the QueryCache class when calling makeQueryCache (or providing a custom cache).

Use case: I am writing test utilities that allow you to mock named queries and right now the QueryCache methods for getting/setting only work with exact query key matches but when testing, we want to support partial matching.

To handle this, I have to mutate the queryCache that comes back to override methods when it would be nicer to extend QueryCache instead.

class TestQueryCache extends QueryCache {
 // override member methods as-needed
}

const testQueryCache = makeQueryCache(TestQueryCache);
// or queryCaches.push(testQueryCache) could also probably work
// but this leaks implementation details

At the crux of this I am looking for a way to intercept cache gets and sets, so any way to accomplish the same thing would work as well. 👍

[todortotev]

@tannerlinsley
If there is something I can help with I would be glad to assist.

[boschni]

@kamranayub in the latest version the QueryCache class is exported and can be used to instantiate a query cache