Skip to content

feat(@tanstack/query): add queryOptions override parameter to generated useQuery hooks #3528

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
nmokkenstorm wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(@tanstack/query): add queryOptions override parameter to generated useQuery hooks #3528

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions .changeset/tanstack-usequery-queryoptions-override.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
"@hey-api/openapi-ts": minor
---

**plugin(@tanstack/react-query, @tanstack/preact-query)**: feat: add `queryOptions` override parameter to generated `useQuery` hooks

When `useQuery` hook generation is enabled, generated hooks now accept an optional `queryOptions` property (typed via a new `UseQueryParams<typeof xOptions>` alias) that is spread over the computed query options, mirroring the existing `mutationOptions` override on `useMutation` hooks. This lets consumers override TanStack Query options like `staleTime`, `gcTime`, or `enabled` per call site without losing type safety.

Opt in to `useQuery` hook generation with `useQuery: true` in your plugin config.
64 changes: 52 additions & 12 deletions ...ts/tanstack-query/v5/__snapshots__/2.0.x/plugins/full-config/@tanstack/react-query.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,14 @@ export const useServiceWithEmptyTagGetQueryData = () => {
return (options: Options<ServiceWithEmptyTagData> | undefined) => queryClient.getQueryData<unknown>(serviceWithEmptyTagOptions(options).queryKey);
};

export const useServiceWithEmptyTagQuery = (options?: Options<ServiceWithEmptyTagData>) => useQuery(serviceWithEmptyTagOptions(options));
type UseQueryParams<TFactory extends (...args: any) => any> = NonNullable<Parameters<TFactory>[0]> & {
queryOptions?: Partial<Omit<ReturnType<TFactory>, 'queryKey' | 'queryFn'>>;
};

export const useServiceWithEmptyTagQuery = (options?: UseQueryParams<typeof serviceWithEmptyTagOptions>) => {
const { queryOptions, ...sdkOptions } = options ?? {};
return useQuery({ ...serviceWithEmptyTagOptions(sdkOptions), ...queryOptions });
};

export const useServiceWithEmptyTagSetQueryData = () => {
const queryClient = useQueryClient();
Expand Down Expand Up @@ -180,7 +187,10 @@ export const useGetCallWithoutParametersAndResponseGetQueryData = () => {
return (options: Options<GetCallWithoutParametersAndResponseData> | undefined) => queryClient.getQueryData<unknown>(getCallWithoutParametersAndResponseOptions(options).queryKey);
};

export const useGetCallWithoutParametersAndResponseQuery = (options?: Options<GetCallWithoutParametersAndResponseData>) => useQuery(getCallWithoutParametersAndResponseOptions(options));
export const useGetCallWithoutParametersAndResponseQuery = (options?: UseQueryParams<typeof getCallWithoutParametersAndResponseOptions>) => {
const { queryOptions, ...sdkOptions } = options ?? {};
return useQuery({ ...getCallWithoutParametersAndResponseOptions(sdkOptions), ...queryOptions });
};

export const useGetCallWithoutParametersAndResponseSetQueryData = () => {
const queryClient = useQueryClient();
Expand Down Expand Up @@ -325,7 +335,10 @@ export const useCallWithDefaultParametersGetQueryData = () => {
return (options: Options<CallWithDefaultParametersData>) => queryClient.getQueryData<unknown>(callWithDefaultParametersOptions(options).queryKey);
};

export const useCallWithDefaultParametersQuery = (options: Options<CallWithDefaultParametersData>) => useQuery(callWithDefaultParametersOptions(options));
export const useCallWithDefaultParametersQuery = (options: UseQueryParams<typeof callWithDefaultParametersOptions>) => {
const { queryOptions, ...sdkOptions } = options;
return useQuery({ ...callWithDefaultParametersOptions(sdkOptions), ...queryOptions });
};

export const useCallWithDefaultParametersSetQueryData = () => {
const queryClient = useQueryClient();
Expand Down Expand Up @@ -413,7 +426,10 @@ export const useDuplicateName2GetQueryData = () => {
return (options: Options<DuplicateName2Data> | undefined) => queryClient.getQueryData<unknown>(duplicateName2Options(options).queryKey);
};

export const useDuplicateName2Query = (options?: Options<DuplicateName2Data>) => useQuery(duplicateName2Options(options));
export const useDuplicateName2Query = (options?: UseQueryParams<typeof duplicateName2Options>) => {
const { queryOptions, ...sdkOptions } = options ?? {};
return useQuery({ ...duplicateName2Options(sdkOptions), ...queryOptions });
};

export const useDuplicateName2SetQueryData = () => {
const queryClient = useQueryClient();
Expand Down Expand Up @@ -482,7 +498,10 @@ export const useCallWithNoContentResponseGetQueryData = () => {
return (options: Options<CallWithNoContentResponseData> | undefined) => queryClient.getQueryData<unknown>(callWithNoContentResponseOptions(options).queryKey);
};

export const useCallWithNoContentResponseQuery = (options?: Options<CallWithNoContentResponseData>) => useQuery(callWithNoContentResponseOptions(options));
export const useCallWithNoContentResponseQuery = (options?: UseQueryParams<typeof callWithNoContentResponseOptions>) => {
const { queryOptions, ...sdkOptions } = options ?? {};
return useQuery({ ...callWithNoContentResponseOptions(sdkOptions), ...queryOptions });
};

export const useCallWithNoContentResponseSetQueryData = () => {
const queryClient = useQueryClient();
Expand Down Expand Up @@ -513,7 +532,10 @@ export const useCallWithResponseAndNoContentResponseGetQueryData = () => {
return (options: Options<CallWithResponseAndNoContentResponseData> | undefined) => queryClient.getQueryData<CallWithResponseAndNoContentResponseResponse>(callWithResponseAndNoContentResponseOptions(options).queryKey);
};

export const useCallWithResponseAndNoContentResponseQuery = (options?: Options<CallWithResponseAndNoContentResponseData>) => useQuery(callWithResponseAndNoContentResponseOptions(options));
export const useCallWithResponseAndNoContentResponseQuery = (options?: UseQueryParams<typeof callWithResponseAndNoContentResponseOptions>) => {
const { queryOptions, ...sdkOptions } = options ?? {};
return useQuery({ ...callWithResponseAndNoContentResponseOptions(sdkOptions), ...queryOptions });
};

export const useCallWithResponseAndNoContentResponseSetQueryData = () => {
const queryClient = useQueryClient();
Expand Down Expand Up @@ -544,7 +566,10 @@ export const useDummyAGetQueryData = () => {
return (options: Options<DummyAData> | undefined) => queryClient.getQueryData<unknown>(dummyAOptions(options).queryKey);
};

export const useDummyAQuery = (options?: Options<DummyAData>) => useQuery(dummyAOptions(options));
export const useDummyAQuery = (options?: UseQueryParams<typeof dummyAOptions>) => {
const { queryOptions, ...sdkOptions } = options ?? {};
return useQuery({ ...dummyAOptions(sdkOptions), ...queryOptions });
};

export const useDummyASetQueryData = () => {
const queryClient = useQueryClient();
Expand Down Expand Up @@ -575,7 +600,10 @@ export const useDummyBGetQueryData = () => {
return (options: Options<DummyBData> | undefined) => queryClient.getQueryData<unknown>(dummyBOptions(options).queryKey);
};

export const useDummyBQuery = (options?: Options<DummyBData>) => useQuery(dummyBOptions(options));
export const useDummyBQuery = (options?: UseQueryParams<typeof dummyBOptions>) => {
const { queryOptions, ...sdkOptions } = options ?? {};
return useQuery({ ...dummyBOptions(sdkOptions), ...queryOptions });
};

export const useDummyBSetQueryData = () => {
const queryClient = useQueryClient();
Expand Down Expand Up @@ -606,7 +634,10 @@ export const useCallWithResponseGetQueryData = () => {
return (options: Options<CallWithResponseData> | undefined) => queryClient.getQueryData<CallWithResponseResponse>(callWithResponseOptions(options).queryKey);
};

export const useCallWithResponseQuery = (options?: Options<CallWithResponseData>) => useQuery(callWithResponseOptions(options));
export const useCallWithResponseQuery = (options?: UseQueryParams<typeof callWithResponseOptions>) => {
const { queryOptions, ...sdkOptions } = options ?? {};
return useQuery({ ...callWithResponseOptions(sdkOptions), ...queryOptions });
};

export const useCallWithResponseSetQueryData = () => {
const queryClient = useQueryClient();
Expand Down Expand Up @@ -675,7 +706,10 @@ export const useCollectionFormatGetQueryData = () => {
return (options: Options<CollectionFormatData>) => queryClient.getQueryData<unknown>(collectionFormatOptions(options).queryKey);
};

export const useCollectionFormatQuery = (options: Options<CollectionFormatData>) => useQuery(collectionFormatOptions(options));
export const useCollectionFormatQuery = (options: UseQueryParams<typeof collectionFormatOptions>) => {
const { queryOptions, ...sdkOptions } = options;
return useQuery({ ...collectionFormatOptions(sdkOptions), ...queryOptions });
};

export const useCollectionFormatSetQueryData = () => {
const queryClient = useQueryClient();
Expand Down Expand Up @@ -706,7 +740,10 @@ export const useTypesGetQueryData = () => {
return (options: Options<TypesData>) => queryClient.getQueryData<TypesResponse>(typesOptions(options).queryKey);
};

export const useTypesQuery = (options: Options<TypesData>) => useQuery(typesOptions(options));
export const useTypesQuery = (options: UseQueryParams<typeof typesOptions>) => {
const { queryOptions, ...sdkOptions } = options;
return useQuery({ ...typesOptions(sdkOptions), ...queryOptions });
};

export const useTypesSetQueryData = () => {
const queryClient = useQueryClient();
Expand Down Expand Up @@ -737,7 +774,10 @@ export const useComplexTypesGetQueryData = () => {
return (options: Options<ComplexTypesData>) => queryClient.getQueryData<ComplexTypesResponse>(complexTypesOptions(options).queryKey);
};

export const useComplexTypesQuery = (options: Options<ComplexTypesData>) => useQuery(complexTypesOptions(options));
export const useComplexTypesQuery = (options: UseQueryParams<typeof complexTypesOptions>) => {
const { queryOptions, ...sdkOptions } = options;
return useQuery({ ...complexTypesOptions(sdkOptions), ...queryOptions });
};

export const useComplexTypesSetQueryData = () => {
const queryClient = useQueryClient();
Expand Down
Loading
Loading