Skip to content

upd(vue-query): Improve queryOptions() type #9774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+142 −37
Open

upd(vue-query): Improve queryOptions() type #9774

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
300a6d4
upd(vue-query): Improve queryOptions() type
Serpentarius13 Oct 16, 2025
7709309
Add changeset
Serpentarius13 Oct 16, 2025
8d3f77a
ci: apply automated fixes
autofix-ci[bot] Oct 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/seven-apes-boil.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@tanstack/vue-query': patch
---

Change UseQueryOptions and its derivatives
36 changes: 28 additions & 8 deletions packages/vue-query/src/queryOptions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,51 @@
import type { DataTag, DefaultError, QueryKey } from '@tanstack/query-core'
import type {
DefinedInitialQueryOptions,
DefinedInitialQueryOptionsBase,
DefinedInitialQueryOptionsRef,
UndefinedInitialQueryOptions,
UndefinedInitialQueryOptionsBase,
UndefinedInitialQueryOptionsRef,
} from './useQuery'

export function queryOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
TOptions = DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
TReturnQueryKey = {
queryKey: DataTag<TQueryKey, TQueryFnData, TError>
},
>(
options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
): DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
queryKey: DataTag<TQueryKey, TQueryFnData, TError>
}
options: TOptions,
): TOptions extends { value: unknown }
? DefinedInitialQueryOptionsRef<TQueryFnData, TError, TData, TQueryKey> &
TOptions
: DefinedInitialQueryOptionsBase<TQueryFnData, TError, TData, TQueryKey> &
TOptions

export function queryOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
TOptions = UndefinedInitialQueryOptions<
TQueryFnData,
TError,
TData,
TQueryKey
>
>(
options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
): UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
queryKey: DataTag<TQueryKey, TQueryFnData, TError>
}
options: TOptions,
): TOptions extends { value: unknown }
? UndefinedInitialQueryOptionsRef<TQueryFnData, TError, TData, TQueryKey> &
TOptions
: UndefinedInitialQueryOptionsBase<TQueryFnData, TError, TData, TQueryKey> &
TOptions
Copy link
Contributor

@coderabbitai coderabbitai bot Oct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

Overload selection is now broken—second signature is unreachable

Both overloads accept a free TOptions parameter with no constraint, so the first signature always matches. Calls such as queryOptions({ queryKey: ['key'] }) now resolve to the defined branch even though no initialData is provided, regressing the typing guarantees you’re trying to preserve. Constrain each overload’s TOptions to its intended option family (Defined vs. Undefined) so TypeScript can discriminate correctly.

 export function queryOptions<
   TQueryFnData = unknown,
   TError = DefaultError,
   TData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
-  TOptions = DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
+  TOptions extends DefinedInitialQueryOptions<
+    TQueryFnData,
+    TError,
+    TData,
+    TQueryKey
+  > = DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 >(options: TOptions): TOptions extends { value: unknown }
   ? DefinedInitialQueryOptionsRef<TQueryFnData, TError, TData, TQueryKey> &
     TOptions
   : DefinedInitialQueryOptionsBase<TQueryFnData, TError, TData, TQueryKey> &
     TOptions
 
 export function queryOptions<
   TQueryFnData = unknown,
   TError = DefaultError,
   TData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
-  TOptions = UndefinedInitialQueryOptions<
+  TOptions extends UndefinedInitialQueryOptions<
     TQueryFnData,
     TError,
     TData,
     TQueryKey
-  >
+  > = UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 >(options: TOptions): TOptions extends { value: unknown }
   ? UndefinedInitialQueryOptionsRef<TQueryFnData, TError, TData, TQueryKey> &
     TOptions
   : UndefinedInitialQueryOptionsBase<TQueryFnData, TError, TData, TQueryKey> &
     TOptions
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
export function queryOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
TOptions = DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
TReturnQueryKey = {
queryKey: DataTag<TQueryKey, TQueryFnData, TError>
},
>(
options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
): DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
queryKey: DataTag<TQueryKey, TQueryFnData, TError>
}
options: TOptions,
): TOptions extends { value: unknown }
? DefinedInitialQueryOptionsRef<TQueryFnData, TError, TData, TQueryKey> &
TOptions
: DefinedInitialQueryOptionsBase<TQueryFnData, TError, TData, TQueryKey> &
TOptions
export function queryOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
TOptions = UndefinedInitialQueryOptions<
TQueryFnData,
TError,
TData,
TQueryKey
>
>(
options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
): UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
queryKey: DataTag<TQueryKey, TQueryFnData, TError>
}
options: TOptions,
): TOptions extends { value: unknown }
? UndefinedInitialQueryOptionsRef<TQueryFnData, TError, TData, TQueryKey> &
TOptions
: UndefinedInitialQueryOptionsBase<TQueryFnData, TError, TData, TQueryKey> &
TOptions
export function queryOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
TOptions extends DefinedInitialQueryOptions<
TQueryFnData,
TError,
TData,
TQueryKey
> = DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
TReturnQueryKey = {
queryKey: DataTag<TQueryKey, TQueryFnData, TError>
},
>(
options: TOptions,
): TOptions extends { value: unknown }
? DefinedInitialQueryOptionsRef<TQueryFnData, TError, TData, TQueryKey> &
TOptions
: DefinedInitialQueryOptionsBase<TQueryFnData, TError, TData, TQueryKey> &
TOptions
export function queryOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
TOptions extends UndefinedInitialQueryOptions<
TQueryFnData,
TError,
TData,
TQueryKey
> = UndefinedInitialQueryOptions<
TQueryFnData,
TError,
TData,
TQueryKey
>
>(
options: TOptions,
): TOptions extends { value: unknown }
? UndefinedInitialQueryOptionsRef<TQueryFnData, TError, TData, TQueryKey> &
TOptions
: UndefinedInitialQueryOptionsBase<TQueryFnData, TError, TData, TQueryKey> &
TOptions
🤖 Prompt for AI Agents 
In packages/vue-query/src/queryOptions.ts around lines 11 to 45, the overloads
both declare a free generic TOptions so the first overload always matches and
the undefined-case becomes unreachable; constrain each overload’s TOptions
generic to the specific option family it represents (i.e. use TOptions extends
DefinedInitialQueryOptions<...> for the defined overload and TOptions extends
UndefinedInitialQueryOptions<...> for the undefined overload) so TypeScript can
discriminate between the two and restore correct return typing.


export function queryOptions(options: unknown) {
return options
}


125 changes: 92 additions & 33 deletions packages/vue-query/src/useQuery.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,65 +18,124 @@ import type {
ShallowOption,
} from './types'
import type { QueryClient } from './queryClient'
import { ComputedRef, Ref } from 'vue'

export type UseQueryOptions<
export type UseQueryOptionsBase<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> = MaybeRef<
{
[Property in keyof QueryObserverOptions<
> = {
[Property in keyof QueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryData,
TQueryKey
>]: Property extends 'enabled'
?
| MaybeRefOrGetter<boolean | undefined>
| (() => Enabled<
TQueryFnData,
TError,
TQueryData,
DeepUnwrapRef<TQueryKey>
>)
: MaybeRefDeep<
QueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryData,
TQueryKey
>]: Property extends 'enabled'
?
| MaybeRefOrGetter<boolean | undefined>
| (() => Enabled<
TQueryFnData,
TError,
TQueryData,
DeepUnwrapRef<TQueryKey>
>)
: MaybeRefDeep<
QueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryData,
DeepUnwrapRef<TQueryKey>
>[Property]
>
} & ShallowOption
>
DeepUnwrapRef<TQueryKey>
>[Property]
>
} & ShallowOption

export type UndefinedInitialQueryOptions<
export type UseQueryOptionsRef<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> =
| Ref<UseQueryOptionsBase<TQueryFnData, TError, TData, TQueryData, TQueryKey>>
| ComputedRef<
UseQueryOptionsBase<TQueryFnData, TError, TData, TQueryData, TQueryKey>
>

export type UseQueryOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> =
| UseQueryOptionsBase<TQueryFnData, TError, TData, TQueryData, TQueryKey>
| UseQueryOptionsRef<TQueryFnData, TError, TData, TQueryData, TQueryKey>

export type UndefinedInitialQueryOptionsBase<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> & {
> = UseQueryOptionsBase<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> & {
initialData?:
| undefined
| InitialDataFunction<NonUndefinedGuard<TQueryFnData>>
| NonUndefinedGuard<TQueryFnData>
| undefined
| InitialDataFunction<NonUndefinedGuard<TQueryFnData>>
| NonUndefinedGuard<TQueryFnData>
}

export type DefinedInitialQueryOptions<
export type UndefinedInitialQueryOptionsRef<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> = UseQueryOptionsRef<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> & {
initialData?:
| undefined
| InitialDataFunction<NonUndefinedGuard<TQueryFnData>>
| NonUndefinedGuard<TQueryFnData>
}

export type UndefinedInitialQueryOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> = UndefinedInitialQueryOptionsBase<TQueryFnData, TError, TData, TQueryKey> | UndefinedInitialQueryOptionsRef<TQueryFnData, TError, TData, TQueryKey>

export type DefinedInitialQueryOptionsBase<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> & {
> = UseQueryOptionsBase<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> & {
initialData:
| NonUndefinedGuard<TQueryFnData>
| NonUndefinedGuard<TQueryFnData>
| (() => NonUndefinedGuard<TQueryFnData>)
}

export type DefinedInitialQueryOptionsRef<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> = UseQueryOptionsRef<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> & {
value: UseQueryOptionsRef<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>['value'] & {
initialData: NonUndefinedGuard<TQueryFnData>
| (() => NonUndefinedGuard<TQueryFnData>)
}
}

export type DefinedInitialQueryOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> = DefinedInitialQueryOptionsBase<TQueryFnData, TError, TData, TQueryKey> | DefinedInitialQueryOptionsRef<TQueryFnData, TError, TData, TQueryKey>

export type UseQueryReturnType<TData, TError> = UseBaseQueryReturnType<
TData,
TError
Expand Down
Loading