Skip to content

Commit ba7fc56

Browse files
authored
refactor: move queryOptions to its own file (#5480)
* refactor: remove 'use client' from non-components * refactor: move queryOptions to its own file where we don't have a 'use client' directive, because we can call this function on the server as well * Revert "refactor: remove 'use client' from non-components" This reverts commit 8ecac66. * refactor: rename isRestoring file * chore: fix import
1 parent b99bf33 commit ba7fc56

File tree

5 files changed

+50
-41
lines changed

5 files changed

+50
-41
lines changed

packages/react-query/src/__tests__/useQuery.types.test.tsx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
import { queryOptions, useQuery } from '../useQuery'
1+
import { useQuery } from '../useQuery'
2+
import { queryOptions } from '../queryOptions'
23
import type { Expect, Equal } from './utils'
34
import { doNotExecute } from './utils'
45

packages/react-query/src/index.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ export * from '@tanstack/query-core'
77
export * from './types'
88
export { useQueries } from './useQueries'
99
export type { QueriesResults, QueriesOptions } from './useQueries'
10-
export { useQuery, queryOptions } from './useQuery'
10+
export { useQuery } from './useQuery'
11+
export { queryOptions } from './queryOptions'
1112
export {
1213
QueryClientContext,
1314
QueryClientProvider,
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
import type { DefaultError, QueryKey } from '@tanstack/query-core'
2+
import type { UseQueryOptions } from './types'
3+
4+
export type UndefinedInitialDataOptions<
5+
TQueryFnData = unknown,
6+
TError = DefaultError,
7+
TData = TQueryFnData,
8+
TQueryKey extends QueryKey = QueryKey,
9+
> = UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
10+
initialData?: undefined
11+
}
12+
13+
export type DefinedInitialDataOptions<
14+
TQueryFnData = unknown,
15+
TError = DefaultError,
16+
TData = TQueryFnData,
17+
TQueryKey extends QueryKey = QueryKey,
18+
> = UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
19+
initialData: TQueryFnData | (() => TQueryFnData)
20+
}
21+
22+
export function queryOptions<
23+
TQueryFnData = unknown,
24+
TError = DefaultError,
25+
TData = TQueryFnData,
26+
TQueryKey extends QueryKey = QueryKey,
27+
>(
28+
options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
29+
): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
30+
31+
export function queryOptions<
32+
TQueryFnData = unknown,
33+
TError = DefaultError,
34+
TData = TQueryFnData,
35+
TQueryKey extends QueryKey = QueryKey,
36+
>(
37+
options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
38+
): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
39+
40+
export function queryOptions(options: unknown) {
41+
return options
42+
}

packages/react-query/src/useQuery.ts

Lines changed: 4 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -7,47 +7,12 @@ import type {
77
UseQueryResult,
88
} from './types'
99
import { useBaseQuery } from './useBaseQuery'
10-
11-
export function queryOptions<
12-
TQueryFnData = unknown,
13-
TError = DefaultError,
14-
TData = TQueryFnData,
15-
TQueryKey extends QueryKey = QueryKey,
16-
>(
17-
options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
18-
): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
19-
20-
export function queryOptions<
21-
TQueryFnData = unknown,
22-
TError = DefaultError,
23-
TData = TQueryFnData,
24-
TQueryKey extends QueryKey = QueryKey,
25-
>(
26-
options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
27-
): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
28-
29-
export function queryOptions(options: unknown) {
30-
return options
31-
}
10+
import type {
11+
DefinedInitialDataOptions,
12+
UndefinedInitialDataOptions,
13+
} from './queryOptions'
3214

3315
// HOOK
34-
type UndefinedInitialDataOptions<
35-
TQueryFnData = unknown,
36-
TError = DefaultError,
37-
TData = TQueryFnData,
38-
TQueryKey extends QueryKey = QueryKey,
39-
> = UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
40-
initialData?: undefined
41-
}
42-
43-
type DefinedInitialDataOptions<
44-
TQueryFnData = unknown,
45-
TError = DefaultError,
46-
TData = TQueryFnData,
47-
TQueryKey extends QueryKey = QueryKey,
48-
> = UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
49-
initialData: TQueryFnData | (() => TQueryFnData)
50-
}
5116

5217
export function useQuery<
5318
TQueryFnData = unknown,

0 commit comments

Comments
 (0)