Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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/fix-query-options-types-fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@tanstack/vue-query': patch
---

fix(vue-query): expose queryFn and other properties on queryOptions return type
15 changes: 15 additions & 0 deletions packages/vue-query/src/__tests__/queryOptions.test-d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,21 @@ import { queryOptions } from '../queryOptions'
import { useQuery } from '../useQuery'

describe('queryOptions', () => {
it('should expose queryFn and other properties on the returned options object', () => {
const options = queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(5),
staleTime: 1000,
})

// These should be accessible without TS errors (issue #7892)
expectTypeOf(options.queryFn).toMatchTypeOf<
(() => Promise<number>) | undefined
>()
expectTypeOf(options.staleTime).toMatchTypeOf<number | undefined>()
expectTypeOf(options.queryKey).toMatchTypeOf<ReadonlyArray<unknown>>()
})

it('should not allow excess properties', () => {
assertType(
queryOptions({
Expand Down
44 changes: 39 additions & 5 deletions packages/vue-query/src/queryOptions.ts
Original file line number Diff line number Diff line change
@@ -1,17 +1,51 @@
import type { DataTag, DefaultError, QueryKey } from '@tanstack/query-core'
import type {
DataTag,
DefaultError,
QueryFunction,
QueryKey,
} from '@tanstack/query-core'
import type {
DefinedInitialQueryOptions,
UndefinedInitialQueryOptions,
} from './useQuery'
import type { DeepUnwrapRef } from './types'

/**
* Augmented version of UndefinedInitialQueryOptions that explicitly exposes
* queryFn and other properties for direct TypeScript access.
*/
export type UndefinedInitialDataOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> = UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
queryKey: TQueryKey
queryFn?: QueryFunction<TQueryFnData, DeepUnwrapRef<TQueryKey>>
}

/**
* Augmented version of DefinedInitialQueryOptions that explicitly exposes
* queryFn and other properties for direct TypeScript access.
*/
export type DefinedInitialDataOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> = DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
queryKey: TQueryKey
queryFn?: QueryFunction<TQueryFnData, DeepUnwrapRef<TQueryKey>>
}

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

Expand All @@ -21,8 +55,8 @@ export function queryOptions<
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
>(
options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
): UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
queryKey: DataTag<TQueryKey, TQueryFnData, TError>
}

Expand Down
Loading