Skip to content

fix(solid-query): export queryOptions without type errors#9668

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

Merged
TkDodo merged 5 commits into from
Sep 24, 2025
Merged

fix(solid-query): export queryOptions without type errors #9668

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0136412
fix(solid-query): add missing generic error type
Zen-cronic Sep 20, 2025
6dab12c
refactor(solid-query): remove unused generic type
Zen-cronic Sep 20, 2025
7d1d260
test(solid-query): add case for error tag
Zen-cronic Sep 20, 2025
e7cc7c7
Merge branch 'main' into fix/solid-js-query-options-export
Zen-cronic Sep 21, 2025
79cf946
Merge branch 'main' into fix/solid-js-query-options-export
TkDodo Sep 24, 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
15 changes: 14 additions & 1 deletion packages/solid-query/src/__tests__/queryOptions.test-d.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
import { assertType, describe, expectTypeOf, it } from 'vitest'
import { QueryClient, dataTagSymbol, skipToken } from '@tanstack/query-core'
import {
QueryClient,
dataTagErrorSymbol,
dataTagSymbol,
skipToken,
} from '@tanstack/query-core'
import { useQuery } from '../useQuery'
import { queryOptions } from '../queryOptions'

Expand DownExpand Up@@ -74,6 +79,14 @@ describe('queryOptions', () => {

expectTypeOf(queryKey[dataTagSymbol]).toEqualTypeOf<number>()
})
it('should tag the queryKey with the default error type', () => {
const { queryKey } = queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(1),
})

expectTypeOf(queryKey[dataTagErrorSymbol]).toEqualTypeOf<Error>()

@Zen-cronicZen-cronicSep 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

before the fix, this was typeof unsetMarker which ts treated as an "inaccessible unique symbol"

})
it('should return the proper type when passed to getQueryData', () => {
const { queryKey } = queryOptions({
queryKey: ['key'],
Expand Down
14 changes: 2 additions & 12 deletions packages/solid-query/src/queryOptions.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,39 +29,29 @@ export function queryOptions<
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
TOptions extends ReturnType<
UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
> = ReturnType<
UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
>,
>(
options: ReturnType<
UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
>,
): ReturnType<
UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
> & {
queryKey: DataTag<TQueryKey, TQueryFnData>
queryKey: DataTag<TQueryKey, TQueryFnData, TError>
}
Comment on lines +39 to 40

@coderabbitaicoderabbitaiBotSep 24, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

🧩 Analysis chain

Key fix: include TError in DataTag for queryKey

Passing TError prevents UnsetMarker from leaking into the emitted d.ts and addresses TS2527. LGTM.

Optionally verify parity across integrations to avoid regressions elsewhere:

🏁 Script executed:

#!/bin/bash# Find queryOptions wrappers that still tag queryKey without TError.
fd --type f 'queryOptions.ts' packages |whileread -r f;doecho">>> $f"
rg -nP 'queryKey:\s*DataTag<\s*[^,>]+,\s*[^,>]+\s*>'"$f"done# Also check for infiniteQueryOptions wrappers if present.
fd --type f 'infiniteQueryOptions.ts' packages |whileread -r f;doecho">>> $f"
rg -nP 'queryKey:\s*DataTag<\s*[^,>]+,\s*[^,>]+\s*>'"$f"done

Length of output: 962

Key fix: include TError in DataTag for queryKey across packages

Add the third generic parameter (TError) to prevent UnsetMarker leaking into emitted d.ts and resolve TS2527.

Files to update:

  • packages/svelte-query/src/queryOptions.ts — change
    queryKey: DataTag<TQueryKey, TQueryFnData>
    -> queryKey: DataTag<TQueryKey, TQueryFnData, TError> (matches ~lines 38, 49)
  • packages/solid-query/src/infiniteQueryOptions.ts — change
    queryKey: DataTag<TQueryKey, InfiniteData>
    -> queryKey: DataTag<TQueryKey, InfiniteData, TError> (matches ~lines 74, 101)

Verify parity in other packages' queryOptions.ts / infiniteQueryOptions.ts after applying.


export function queryOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
TOptions extends ReturnType<
DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
> = ReturnType<
DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
>,
>(
options: ReturnType<
DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
>,
): ReturnType<
DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
> & {
queryKey: DataTag<TQueryKey, TQueryFnData>
queryKey: DataTag<TQueryKey, TQueryFnData, TError>
}

export function queryOptions(options: unknown) {
Expand Down
Loading