feat(v4): backport some v5 apis to v4 branch #8754
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| import type { | ||
| InitialDataFunction, | ||
| QueryFunction, | ||
| QueryKey, | ||
| } from '@tanstack/query-core' | ||
| import type { UseQueryOptions } from './types' | ||
|
|
||
| export type UndefinedInitialDataOptions< | ||
| TQueryFnData = unknown, | ||
| TError = unknown, | ||
| TData = TQueryFnData, | ||
| TQueryKey extends QueryKey = QueryKey, | ||
| > = UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & { | ||
| initialData?: | ||
| | undefined | ||
| | InitialDataFunction<NonUndefinedGuard<TQueryFnData>> | ||
| | NonUndefinedGuard<TQueryFnData> | ||
| } | ||
|
|
||
| type NonUndefinedGuard<T> = T extends undefined ? never : T | ||
|
|
||
| export type DefinedInitialDataOptions< | ||
| TQueryFnData = unknown, | ||
| TError = unknown, | ||
| TData = TQueryFnData, | ||
| TQueryKey extends QueryKey = QueryKey, | ||
| > = Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryFn'> & { | ||
| initialData: | ||
| | NonUndefinedGuard<TQueryFnData> | ||
| | (() => NonUndefinedGuard<TQueryFnData>) | ||
| queryFn?: QueryFunction<TQueryFnData, TQueryKey> | ||
| } | ||
|
|
||
| export function queryOptions< | ||
| TQueryFnData = unknown, | ||
| TError = unknown, | ||
| TData = TQueryFnData, | ||
| TQueryKey extends QueryKey = QueryKey, | ||
| >( | ||
| options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, | ||
| ): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & { | ||
| queryKey: TQueryKey | ||
| } | ||
|
|
||
| export function queryOptions< | ||
| TQueryFnData = unknown, | ||
| TError = unknown, | ||
| TData = TQueryFnData, | ||
| TQueryKey extends QueryKey = QueryKey, | ||
| >( | ||
| options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, | ||
| ): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & { | ||
| queryKey: TQueryKey | ||
| } | ||
|
|
||
| export function queryOptions(options: unknown) { | ||
| return options | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,26 @@ | ||||||||||||||||||||||||||||||||||||||||
| 'use client' | ||||||||||||||||||||||||||||||||||||||||
| import { QueryObserver } from '@tanstack/query-core' | ||||||||||||||||||||||||||||||||||||||||
| import { useBaseQuery } from './useBaseQuery' | ||||||||||||||||||||||||||||||||||||||||
| import type { QueryKey } from '@tanstack/query-core' | ||||||||||||||||||||||||||||||||||||||||
| import type { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './types' | ||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||
| // HOOK | ||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||
| export function useSuspenseQuery< | ||||||||||||||||||||||||||||||||||||||||
| TQueryFnData = unknown, | ||||||||||||||||||||||||||||||||||||||||
| TError = unknown, | ||||||||||||||||||||||||||||||||||||||||
| TData = TQueryFnData, | ||||||||||||||||||||||||||||||||||||||||
| TQueryKey extends QueryKey = QueryKey, | ||||||||||||||||||||||||||||||||||||||||
| >( | ||||||||||||||||||||||||||||||||||||||||
| options: UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, | ||||||||||||||||||||||||||||||||||||||||
| ): UseSuspenseQueryResult<TData, TError> { | ||||||||||||||||||||||||||||||||||||||||
| return useBaseQuery( | ||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||
| ...options, | ||||||||||||||||||||||||||||||||||||||||
| enabled: true, | ||||||||||||||||||||||||||||||||||||||||
| suspense: true, | ||||||||||||||||||||||||||||||||||||||||
| placeholderData: undefined, | ||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||
| QueryObserver, | ||||||||||||||||||||||||||||||||||||||||
| ) as UseSuspenseQueryResult<TData, TError> | ||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+17
to
+25
There was a problem hiding this comment. We should avoid allowing useErrorBoundary to be set to false here.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In my opinion, we should add type tests for queryOptions using Vitest.
It’s important to guarantee type safety:
You can refer to the link below for a good example of what and how to type test:
https://github.com/toss/suspensive/tree/main/packages/react-query-4/src
I really appreciate this work — I've created @suspensive/react-query in the past because I use TanStack Query v4 at my company yet.
Your approach will actually help me remove some unnecessary code from my project.
Let’s tackle this step by step and make it perfect.