Skip to content

Commit 70b72ef

Browse files
committed
feat: add optional parameters to QueryFnOptions and enhance interface structure
1 parent 78e3403 commit 70b72ef

2 files changed

Lines changed: 13 additions & 14 deletions

File tree

packages/tanstack-query-react-types/src/service-operation/ServiceOperationQueryFn.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import type {
22
AreAllOptional,
3+
QueryFnOptions,
34
QueryFnOptionsByParameters,
45
QueryFnOptionsByQueryKey,
56
RequestFnResponse,
@@ -18,7 +19,10 @@ export interface ServiceOperationQueryFn<
1819
options:
1920
| QueryFnOptionsByQueryKey<TSchema, TQueryParams, TMeta, TSignal>
2021
| (AreAllOptional<TQueryParams> extends true
21-
? QueryFnOptionsByParameters<TQueryParams, TMeta, TSignal> | void
22+
?
23+
| QueryFnOptionsByParameters<TQueryParams, TMeta, TSignal>
24+
| QueryFnOptions<TMeta, TSignal>
25+
| void
2226
: QueryFnOptionsByParameters<TQueryParams, TMeta, TSignal>),
2327
client?: (
2428
schema: TSchema,
Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
import type { ServiceOperationQueryKey } from '@openapi-qraft/tanstack-query-react-types';
22
import type { DeepReadonly } from './DeepReadonly.js';
33

4-
interface QueryFnOptionsBase<
4+
export interface QueryFnOptions<
55
TMeta extends Record<string, any>,
66
TSignal extends AbortSignal = AbortSignal,
77
> {
88
signal?: TSignal;
99
meta?: TMeta;
10+
/**
11+
* Base URL to use for the request
12+
* @example 'https://api.example.com'
13+
*/
14+
baseUrl?: string;
1015
}
1116

1217
export interface QueryFnOptionsByParameters<
1318
TParams,
1419
TMeta extends Record<string, any>,
1520
TSignal extends AbortSignal = AbortSignal,
16-
>
17-
extends QueryFnOptionsBase<TMeta, TSignal>, QueryFnBaseUrlOptions {
21+
> extends QueryFnOptions<TMeta, TSignal> {
1822
parameters: DeepReadonly<TParams>;
1923

2024
queryKey?: never;
@@ -25,17 +29,8 @@ export interface QueryFnOptionsByQueryKey<
2529
TParams,
2630
TMeta extends Record<string, any>,
2731
TSignal extends AbortSignal = AbortSignal,
28-
>
29-
extends QueryFnOptionsBase<TMeta, TSignal>, QueryFnBaseUrlOptions {
32+
> extends QueryFnOptions<TMeta, TSignal> {
3033
queryKey: ServiceOperationQueryKey<TSchema, TParams>;
3134

3235
parameters?: never;
3336
}
34-
35-
interface QueryFnBaseUrlOptions {
36-
/**
37-
* Base URL to use for the request
38-
* @example 'https://api.example.com'
39-
*/
40-
baseUrl?: string;
41-
}

0 commit comments

Comments
 (0)