Skip to content

[vue-query] 5.103.0: UseQueryOptions is no longer assignable to ensureQueryData, fetchQuery and prefetchQuery #11639

Description

@maximilian-hammerl

Describe the bug

Since 5.103.0, a value typed as UseQueryOptions can still be passed to useQuery, but no longer to the query client's ensureQueryData, fetchQuery or prefetchQuery:

Type 'symbol' is not assignable to type 'MaybeRefDeep<unique symbol | QueryFunction<string, readonly unknown[], never> | undefined>'.

#11439 widened queryFn in UseQueryOptions with SkipTokenForUseQuery = symbol. The query client methods still take query-core's options, whose queryFn accepts only typeof skipToken, a unique symbol. Plain symbol is not assignable to it, so the whole options object is rejected.

This hits generated clients: Orval's vue-query output types every get…QueryOptions() getter as UseQueryOptions, so queryClient.ensureQueryData(getXQueryOptions()), the usual pattern in a router guard, stops compiling.

Your minimal, reproducible example

5.103.2, fails: https://www.typescriptlang.org/play/?ts=6.0.3#code/JYWwDg9gTgLgBAbzgRQK4FMoE8DCAbYdAOxgBo5UBndNTLcmLMdOAVWtuwHkwZgIilOAF84AMygQQcAOQABGAENBSgMYBrAPQA3DAFoAjhmwy4mzXEbNKALjgBWAHQBGAAwBmRwCYAUD4Am6Kp4ilAsqgKU8BC8-IJ27DTGWDx8kQA8UVDARADmAHw+ESpwwYQkcAC8cEToAO4oyfjlMAAUAJR+VEl0rTFpgu1mFhHgwHjolEUExDCOxJSoYZxYACKKSn2xkUPmcJiSUHCUOaosTm6ertMtjmLoMKoAFitbA5S7FgfQx6fnLh5HNcyrNHGAwvdHi9km84h9hvsoIdfkQzg4AVcfEA

5.102.8, compiles: https://www.typescriptlang.org/play/?ts=6.0.3#code/JYWwDg9gTgLgBAbzgRQK4FMoE8DCAbYdAOxgBo5UBndNTLcmLMdOAVWtuwHkwZgIilOAF84AMygQQcAOQABGAENBSgMYBrAPQA3DAFoAjhmwy4mzXEbNKALjgBWAHQBGAAwAmRwA4AUD4Am6Kp4ilAsqgKU8BC8-IJ27DTGWDx8kQA8UVDARADmAHw+ESpwwYQkcAC8cEToAO4oyfjlMAAUAJR+VEl0rTFpgu1mFhHgwHjolEUExDCOxJSoYZxYACKKSn2xkUPmpVJg45NwAg4uHt7TLY5i6DCqABYrWwOUuyMHR0KnTm6evmVZo4wGFbvcnskXnE3sN9mMJt8iGc-pcgA

Steps to reproduce

import { QueryClient, useQuery, type UseQueryOptions } from '@tanstack/vue-query'

declare const options: UseQueryOptions<string>
const client = new QueryClient()

useQuery(options) // compiles
client.ensureQueryData(options) // error since 5.103.0
client.fetchQuery(options) // error since 5.103.0
client.prefetchQuery(options) // error since 5.103.0

Expected behavior

Options that useQuery accepts are also accepted by ensureQueryData, fetchQuery and prefetchQuery, as in 5.102.8.

How often does this bug happen?

Every time

Platform

  • OS: macOS 26 and Ubuntu (GitHub Actions)
  • Browser: none, this is a compile-time error from tsc and vue-tsc
  • Version: n/a

Tanstack Query adapter

vue-query

TanStack Query version

v5.103.2

TypeScript version

v6.0.3

Additional context

#11439's new type tests cover useQuery and queryOptions, but none passes UseQueryOptions to a query client method. Passing a literal skipToken to ensureQueryData still compiles. Only the widened symbol fails.

Activity

  1. dawNotPoi commented on Sep 25, 2026

    @dawNotPoi

    I can take this. On current main, UseQueryOptions widens queryFn's skip-token branch to symbol for Vue inference, while the QueryClient methods still require the query-core unique skipToken type. That breaks a shared options object at the Vue client boundary; I also found the same type boundary on the recommended query() replacement.

    I'll first add type tests that reproduce the issue for ensureQueryData, fetchQuery, and prefetchQuery (and verify query()), then adjust only Vue QueryClient's accepted option types. I'll preserve existing inference and reactive unwrapping, and check runtime handling of skipToken and other symbols so the wider type does not promise an unsafe call. I'll run the Vue type and runtime checks and include a patch changeset if the fix affects the published package.

    This work is AI-assisted and will be reviewed and verified before a PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions