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
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).toEqualTypeOf<
(() => Promise<number>) | undefined
>()
expectTypeOf(options.staleTime).toEqualTypeOf<number | undefined>()
expectTypeOf(options.queryKey).toMatchTypeOf<readonly unknown[]>()
})

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

/**
* Options for queryOptions with defined initial data.
* These are unwrapped types (not MaybeRef) so that properties like queryFn are directly accessible.
*/
export type DefinedInitialDataOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> = QueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryFnData,
DeepUnwrapRef<TQueryKey>
> &
ShallowOption & {
initialData:
| NonUndefinedGuard<TQueryFnData>
| (() => NonUndefinedGuard<TQueryFnData>)
}

/**
* Options for queryOptions with undefined initial data.
* These are unwrapped types (not MaybeRef) so that properties like queryFn are directly accessible.
*/
export type UndefinedInitialDataOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> = QueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryFnData,
DeepUnwrapRef<TQueryKey>
> &
ShallowOption & {
initialData?:
| undefined
| InitialDataFunction<NonUndefinedGuard<TQueryFnData>>
| NonUndefinedGuard<TQueryFnData>
}

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 +70,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