Skip to content

feat: add skipToken support and queryOptions override to TanStack Query 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

Draft
nmokkenstorm wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

feat: add skipToken support and queryOptions override to TanStack Query useQuery hooks #3528

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eca659e
feat: inline useQuery in generated hooks to preserve type inference
nmokkenstorm Apr 3, 2026
5eb6a92
test: update tanstack query snapshots for inline useQuery
nmokkenstorm Apr 3, 2026
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
20 changes: 11 additions & 9 deletions ...ts-tests/__snapshots__/plugins/@tanstack/meta/@tanstack/angular-query-experimental.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// This file is auto-generated by @hey-api/openapi-ts

import { type DefaultError, queryOptions } from '@tanstack/angular-query-experimental';
import { type DefaultError, queryOptions, skipToken } from '@tanstack/angular-query-experimental';

import { client } from '../client.gen';
import { getBar, getFoo, type Options } from '../sdk.gen';
Expand Down Expand Up @@ -39,19 +39,21 @@ const createQueryKey = <TOptions extends Options>(id: string, options?: TOptions
return [params];
};

const unwrapSkipToken = <T>(options: T | typeof skipToken): T | undefined => options !== skipToken ? options as T : undefined;

export const getFooQueryKey = (options?: Options<GetFooData>) => createQueryKey('getFoo', options);

export const getFooOptions = (options?: Options<GetFooData>) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getFooQueryKey>>({
queryFn: async ({ queryKey, signal }) => {
export const getFooOptions = (options?: Options<GetFooData> | typeof skipToken) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getFooQueryKey>>({
queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
const { data } = await getFoo({
...options,
...unwrapSkipToken(options),
...queryKey[0],
signal,
throwOnError: true
});
return data;
},
queryKey: getFooQueryKey(options),
queryKey: getFooQueryKey(unwrapSkipToken(options)),
meta: {
id: 'getFoo',
method: 'get',
Expand All @@ -61,17 +63,17 @@ export const getFooOptions = (options?: Options<GetFooData>) => queryOptions<unk

export const getBarQueryKey = (options?: Options<GetBarData>) => createQueryKey('getBar', options);

export const getBarOptions = (options?: Options<GetBarData>) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getBarQueryKey>>({
queryFn: async ({ queryKey, signal }) => {
export const getBarOptions = (options?: Options<GetBarData> | typeof skipToken) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getBarQueryKey>>({
queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
const { data } = await getBar({
...options,
...unwrapSkipToken(options),
...queryKey[0],
signal,
throwOnError: true
});
return data;
},
queryKey: getBarQueryKey(options),
queryKey: getBarQueryKey(unwrapSkipToken(options)),
meta: {
id: 'getBar',
method: 'get',
Expand Down
40 changes: 31 additions & 9 deletions packages/openapi-ts-tests/__snapshots__/plugins/@tanstack/meta/@tanstack/preact-query.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// This file is auto-generated by @hey-api/openapi-ts

import { type DefaultError, queryOptions } from '@tanstack/preact-query';
import { type DefaultError, queryOptions, skipToken, useQuery } from '@tanstack/preact-query';

import { client } from '../client.gen';
import { getBar, getFoo, type Options } from '../sdk.gen';
Expand Down Expand Up @@ -39,42 +39,64 @@ const createQueryKey = <TOptions extends Options>(id: string, options?: TOptions
return [params];
};

const unwrapSkipToken = <T>(options: T | typeof skipToken): T | undefined => options !== skipToken ? options as T : undefined;

export const getFooQueryKey = (options?: Options<GetFooData>) => createQueryKey('getFoo', options);

export const getFooOptions = (options?: Options<GetFooData>) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getFooQueryKey>>({
queryFn: async ({ queryKey, signal }) => {
export const getFooOptions = (options?: Options<GetFooData> | typeof skipToken) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getFooQueryKey>>({
queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
const { data } = await getFoo({
...options,
...unwrapSkipToken(options),
...queryKey[0],
signal,
throwOnError: true
});
return data;
},
queryKey: getFooQueryKey(options),
queryKey: getFooQueryKey(unwrapSkipToken(options)),
meta: {
id: 'getFoo',
method: 'get',
path: '/foo'
}
});

export const useGetFooQuery = (options?: (Options<GetFooData> | typeof skipToken) & {
queryOptions?: Partial<Omit<ReturnType<typeof getFooOptions>, 'queryKey' | 'queryFn'>>;
}) => {
if (options === skipToken) {
return useQuery(getFooOptions(options));
}
const { queryOptions, ...sdkOptions } = options ?? {};
return useQuery({ ...getFooOptions(sdkOptions), ...queryOptions });
};

export const getBarQueryKey = (options?: Options<GetBarData>) => createQueryKey('getBar', options);

export const getBarOptions = (options?: Options<GetBarData>) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getBarQueryKey>>({
queryFn: async ({ queryKey, signal }) => {
export const getBarOptions = (options?: Options<GetBarData> | typeof skipToken) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getBarQueryKey>>({
queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
const { data } = await getBar({
...options,
...unwrapSkipToken(options),
...queryKey[0],
signal,
throwOnError: true
});
return data;
},
queryKey: getBarQueryKey(options),
queryKey: getBarQueryKey(unwrapSkipToken(options)),
meta: {
id: 'getBar',
method: 'get',
path: '/bar'
}
});

export const useGetBarQuery = (options?: (Options<GetBarData> | typeof skipToken) & {
queryOptions?: Partial<Omit<ReturnType<typeof getBarOptions>, 'queryKey' | 'queryFn'>>;
}) => {
if (options === skipToken) {
return useQuery(getBarOptions(options));
}
const { queryOptions, ...sdkOptions } = options ?? {};
return useQuery({ ...getBarOptions(sdkOptions), ...queryOptions });
};
40 changes: 31 additions & 9 deletions packages/openapi-ts-tests/__snapshots__/plugins/@tanstack/meta/@tanstack/react-query.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// This file is auto-generated by @hey-api/openapi-ts

import { type DefaultError, queryOptions } from '@tanstack/react-query';
import { type DefaultError, queryOptions, skipToken, useQuery } from '@tanstack/react-query';

import { client } from '../client.gen';
import { getBar, getFoo, type Options } from '../sdk.gen';
Expand Down Expand Up @@ -39,42 +39,64 @@ const createQueryKey = <TOptions extends Options>(id: string, options?: TOptions
return [params];
};

const unwrapSkipToken = <T>(options: T | typeof skipToken): T | undefined => options !== skipToken ? options as T : undefined;

export const getFooQueryKey = (options?: Options<GetFooData>) => createQueryKey('getFoo', options);

export const getFooOptions = (options?: Options<GetFooData>) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getFooQueryKey>>({
queryFn: async ({ queryKey, signal }) => {
export const getFooOptions = (options?: Options<GetFooData> | typeof skipToken) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getFooQueryKey>>({
queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
const { data } = await getFoo({
...options,
...unwrapSkipToken(options),
...queryKey[0],
signal,
throwOnError: true
});
return data;
},
queryKey: getFooQueryKey(options),
queryKey: getFooQueryKey(unwrapSkipToken(options)),
meta: {
id: 'getFoo',
method: 'get',
path: '/foo'
}
});

export const useGetFooQuery = (options?: (Options<GetFooData> | typeof skipToken) & {
queryOptions?: Partial<Omit<ReturnType<typeof getFooOptions>, 'queryKey' | 'queryFn'>>;
}) => {
if (options === skipToken) {
return useQuery(getFooOptions(options));
}
const { queryOptions, ...sdkOptions } = options ?? {};
return useQuery({ ...getFooOptions(sdkOptions), ...queryOptions });
};

export const getBarQueryKey = (options?: Options<GetBarData>) => createQueryKey('getBar', options);

export const getBarOptions = (options?: Options<GetBarData>) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getBarQueryKey>>({
queryFn: async ({ queryKey, signal }) => {
export const getBarOptions = (options?: Options<GetBarData> | typeof skipToken) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getBarQueryKey>>({
queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
const { data } = await getBar({
...options,
...unwrapSkipToken(options),
...queryKey[0],
signal,
throwOnError: true
});
return data;
},
queryKey: getBarQueryKey(options),
queryKey: getBarQueryKey(unwrapSkipToken(options)),
meta: {
id: 'getBar',
method: 'get',
path: '/bar'
}
});

export const useGetBarQuery = (options?: (Options<GetBarData> | typeof skipToken) & {
queryOptions?: Partial<Omit<ReturnType<typeof getBarOptions>, 'queryKey' | 'queryFn'>>;
}) => {
if (options === skipToken) {
return useQuery(getBarOptions(options));
}
const { queryOptions, ...sdkOptions } = options ?? {};
return useQuery({ ...getBarOptions(sdkOptions), ...queryOptions });
};
20 changes: 11 additions & 9 deletions packages/openapi-ts-tests/__snapshots__/plugins/@tanstack/meta/@tanstack/solid-query.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// This file is auto-generated by @hey-api/openapi-ts

import { type DefaultError, queryOptions } from '@tanstack/solid-query';
import { type DefaultError, queryOptions, skipToken } from '@tanstack/solid-query';

import { client } from '../client.gen';
import { getBar, getFoo, type Options } from '../sdk.gen';
Expand Down Expand Up @@ -39,19 +39,21 @@ const createQueryKey = <TOptions extends Options>(id: string, options?: TOptions
return [params];
};

const unwrapSkipToken = <T>(options: T | typeof skipToken): T | undefined => options !== skipToken ? options as T : undefined;

export const getFooQueryKey = (options?: Options<GetFooData>) => createQueryKey('getFoo', options);

export const getFooOptions = (options?: Options<GetFooData>) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getFooQueryKey>>({
queryFn: async ({ queryKey, signal }) => {
export const getFooOptions = (options?: Options<GetFooData> | typeof skipToken) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getFooQueryKey>>({
queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
const { data } = await getFoo({
...options,
...unwrapSkipToken(options),
...queryKey[0],
signal,
throwOnError: true
});
return data;
},
queryKey: getFooQueryKey(options),
queryKey: getFooQueryKey(unwrapSkipToken(options)),
meta: {
id: 'getFoo',
method: 'get',
Expand All @@ -61,17 +63,17 @@ export const getFooOptions = (options?: Options<GetFooData>) => queryOptions<unk

export const getBarQueryKey = (options?: Options<GetBarData>) => createQueryKey('getBar', options);

export const getBarOptions = (options?: Options<GetBarData>) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getBarQueryKey>>({
queryFn: async ({ queryKey, signal }) => {
export const getBarOptions = (options?: Options<GetBarData> | typeof skipToken) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getBarQueryKey>>({
queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
const { data } = await getBar({
...options,
...unwrapSkipToken(options),
...queryKey[0],
signal,
throwOnError: true
});
return data;
},
queryKey: getBarQueryKey(options),
queryKey: getBarQueryKey(unwrapSkipToken(options)),
meta: {
id: 'getBar',
method: 'get',
Expand Down
20 changes: 11 additions & 9 deletions packages/openapi-ts-tests/__snapshots__/plugins/@tanstack/meta/@tanstack/svelte-query.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// This file is auto-generated by @hey-api/openapi-ts

import { type DefaultError, queryOptions } from '@tanstack/svelte-query';
import { type DefaultError, queryOptions, skipToken } from '@tanstack/svelte-query';

import { client } from '../client.gen';
import { getBar, getFoo, type Options } from '../sdk.gen';
Expand Down Expand Up @@ -39,19 +39,21 @@ const createQueryKey = <TOptions extends Options>(id: string, options?: TOptions
return [params];
};

const unwrapSkipToken = <T>(options: T | typeof skipToken): T | undefined => options !== skipToken ? options as T : undefined;

export const getFooQueryKey = (options?: Options<GetFooData>) => createQueryKey('getFoo', options);

export const getFooOptions = (options?: Options<GetFooData>) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getFooQueryKey>>({
queryFn: async ({ queryKey, signal }) => {
export const getFooOptions = (options?: Options<GetFooData> | typeof skipToken) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getFooQueryKey>>({
queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
const { data } = await getFoo({
...options,
...unwrapSkipToken(options),
...queryKey[0],
signal,
throwOnError: true
});
return data;
},
queryKey: getFooQueryKey(options),
queryKey: getFooQueryKey(unwrapSkipToken(options)),
meta: {
id: 'getFoo',
method: 'get',
Expand All @@ -61,17 +63,17 @@ export const getFooOptions = (options?: Options<GetFooData>) => queryOptions<unk

export const getBarQueryKey = (options?: Options<GetBarData>) => createQueryKey('getBar', options);

export const getBarOptions = (options?: Options<GetBarData>) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getBarQueryKey>>({
queryFn: async ({ queryKey, signal }) => {
export const getBarOptions = (options?: Options<GetBarData> | typeof skipToken) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getBarQueryKey>>({
queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
const { data } = await getBar({
...options,
...unwrapSkipToken(options),
...queryKey[0],
signal,
throwOnError: true
});
return data;
},
queryKey: getBarQueryKey(options),
queryKey: getBarQueryKey(unwrapSkipToken(options)),
meta: {
id: 'getBar',
method: 'get',
Expand Down
20 changes: 11 additions & 9 deletions packages/openapi-ts-tests/__snapshots__/plugins/@tanstack/meta/@tanstack/vue-query.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// This file is auto-generated by @hey-api/openapi-ts

import { type DefaultError, queryOptions } from '@tanstack/vue-query';
import { type DefaultError, queryOptions, skipToken } from '@tanstack/vue-query';

import { client } from '../client.gen';
import { getBar, getFoo, type Options } from '../sdk.gen';
Expand Down Expand Up @@ -39,19 +39,21 @@ const createQueryKey = <TOptions extends Options>(id: string, options?: TOptions
return [params];
};

const unwrapSkipToken = <T>(options: T | typeof skipToken): T | undefined => options !== skipToken ? options as T : undefined;

export const getFooQueryKey = (options?: Options<GetFooData>) => createQueryKey('getFoo', options);

export const getFooOptions = (options?: Options<GetFooData>) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getFooQueryKey>>({
queryFn: async ({ queryKey, signal }) => {
export const getFooOptions = (options?: Options<GetFooData> | typeof skipToken) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getFooQueryKey>>({
queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
const { data } = await getFoo({
...options,
...unwrapSkipToken(options),
...queryKey[0],
signal,
throwOnError: true
});
return data;
},
queryKey: getFooQueryKey(options),
queryKey: getFooQueryKey(unwrapSkipToken(options)),
meta: {
id: 'getFoo',
method: 'get',
Expand All @@ -61,17 +63,17 @@ export const getFooOptions = (options?: Options<GetFooData>) => queryOptions<unk

export const getBarQueryKey = (options?: Options<GetBarData>) => createQueryKey('getBar', options);

export const getBarOptions = (options?: Options<GetBarData>) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getBarQueryKey>>({
queryFn: async ({ queryKey, signal }) => {
export const getBarOptions = (options?: Options<GetBarData> | typeof skipToken) => queryOptions<unknown, DefaultError, unknown, ReturnType<typeof getBarQueryKey>>({
queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
const { data } = await getBar({
...options,
...unwrapSkipToken(options),
...queryKey[0],
signal,
throwOnError: true
});
return data;
},
queryKey: getBarQueryKey(options),
queryKey: getBarQueryKey(unwrapSkipToken(options)),
meta: {
id: 'getBar',
method: 'get',
Expand Down
Loading
Loading