Skip to content

Commit 13d9049

Browse files
arnoud-dvarnoud-dv
committed
fix(angular-query): reorder query function declarations
1 parent 1a1708b commit 13d9049

File tree

5 files changed

+32
-23
lines changed

5 files changed

+32
-23
lines changed

‎packages/angular-query-experimental/etc/angular-query-experimental.api.md

+14-11
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import type { EnvironmentProviders } from '@angular/core';
1212
import type { InfiniteData } from '@tanstack/query-core';
1313
import type { InfiniteQueryObserverOptions } from '@tanstack/query-core';
1414
import type { InfiniteQueryObserverResult } from '@tanstack/query-core';
15+
import type { InitialDataFunction } from '@tanstack/query-core';
1516
import { InjectOptions } from '@angular/core';
1617
import { Injector } from '@angular/core';
1718
import type { MutateFunction } from '@tanstack/query-core';
@@ -111,7 +112,7 @@ export type DefinedCreateQueryResult<TData = unknown, TError = DefaultError, TDe
111112

112113
// @public (undocumented)
113114
export type DefinedInitialDataInfiniteOptions<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam> & {
114-
initialData: NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>> | (() => NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>);
115+
initialData: NonUndefinedGuard_2<InfiniteData<TQueryFnData, TPageParam>> | (() => NonUndefinedGuard_2<InfiniteData<TQueryFnData, TPageParam>>);
115116
};
116117

117118
// @public (undocumented)
@@ -120,20 +121,20 @@ export type DefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultEr
120121
};
121122

122123
// @public
123-
export function infiniteQueryOptions<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & {
124+
export function infiniteQueryOptions<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & {
124125
queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>>;
125126
};
126127

127128
// @public
128-
export function infiniteQueryOptions<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & {
129+
export function infiniteQueryOptions<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & {
129130
queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>>;
130131
};
131132

132133
// @public
133-
export function injectInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(optionsFn: (client: QueryClient) => UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, injector?: Injector): CreateInfiniteQueryResult<TData, TError>;
134+
export function injectInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(optionsFn: (client: QueryClient) => DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, injector?: Injector): DefinedCreateInfiniteQueryResult<TData, TError>;
134135

135136
// @public
136-
export function injectInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(optionsFn: (client: QueryClient) => DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, injector?: Injector): DefinedCreateInfiniteQueryResult<TData, TError>;
137+
export function injectInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(optionsFn: (client: QueryClient) => UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, injector?: Injector): CreateInfiniteQueryResult<TData, TError>;
137138

138139
// @public
139140
export function injectInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(optionsFn: (client: QueryClient) => CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam>, injector?: Injector): CreateInfiniteQueryResult<TData, TError>;
@@ -186,9 +187,6 @@ export const injectQueryClient: {
186187
}): QueryClient;
187188
};
188189

189-
// @public (undocumented)
190-
export type NonUndefinedGuard<T> = T extends undefined ? never : T;
191-
192190
// @public
193191
export function provideAngularQuery(queryClient: QueryClient): EnvironmentProviders;
194192

@@ -224,12 +222,12 @@ GetResults<Head>
224222
]> : T extends Array<QueryObserverOptionsForCreateQueries<infer TQueryFnData, infer TError, infer TData, any>> ? Array<QueryObserverResult<unknown extends TData ? TQueryFnData : TData, unknown extends TError ? DefaultError : TError>> : Array<QueryObserverResult>;
225223

226224
// @public
227-
export function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
225+
export function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
228226
queryKey: DataTag<TQueryKey, TQueryFnData>;
229227
};
230228

231229
// @public
232-
export function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
230+
export function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
233231
queryKey: DataTag<TQueryKey, TQueryFnData>;
234232
};
235233

@@ -240,12 +238,17 @@ export type UndefinedInitialDataInfiniteOptions<TQueryFnData, TError = DefaultEr
240238

241239
// @public (undocumented)
242240
export type UndefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
243-
initialData?: undefined;
241+
initialData?: undefined | InitialDataFunction<NonUndefinedGuard<TQueryFnData>>;
244242
};
245243

246244

247245
export * from "@tanstack/query-core";
248246

247+
// Warnings were encountered during analysis:
248+
//
249+
// build/infinite-query-options.d.ts:14:5 - (ae-forgotten-export) The symbol "NonUndefinedGuard_2" needs to be exported by the entry point index.d.ts
250+
// build/query-options.d.ts:14:5 - (ae-forgotten-export) The symbol "NonUndefinedGuard" needs to be exported by the entry point index.d.ts
251+
249252
// (No @packageDocumentation comment for this package)
250253

251254
```

‎packages/angular-query-experimental/src/infinite-query-options.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -63,14 +63,14 @@ export function infiniteQueryOptions<
6363
TQueryKey extends QueryKey = QueryKey,
6464
TPageParam = unknown,
6565
>(
66-
options: UndefinedInitialDataInfiniteOptions<
66+
options: DefinedInitialDataInfiniteOptions<
6767
TQueryFnData,
6868
TError,
6969
TData,
7070
TQueryKey,
7171
TPageParam
7272
>,
73-
): UndefinedInitialDataInfiniteOptions<
73+
): DefinedInitialDataInfiniteOptions<
7474
TQueryFnData,
7575
TError,
7676
TData,
@@ -95,14 +95,14 @@ export function infiniteQueryOptions<
9595
TQueryKey extends QueryKey = QueryKey,
9696
TPageParam = unknown,
9797
>(
98-
options: DefinedInitialDataInfiniteOptions<
98+
options: UndefinedInitialDataInfiniteOptions<
9999
TQueryFnData,
100100
TError,
101101
TData,
102102
TQueryKey,
103103
TPageParam
104104
>,
105-
): DefinedInitialDataInfiniteOptions<
105+
): UndefinedInitialDataInfiniteOptions<
106106
TQueryFnData,
107107
TError,
108108
TData,

‎packages/angular-query-experimental/src/inject-infinite-query.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ export function injectInfiniteQuery<
3636
>(
3737
optionsFn: (
3838
client: QueryClient,
39-
) => UndefinedInitialDataInfiniteOptions<
39+
) => DefinedInitialDataInfiniteOptions<
4040
TQueryFnData,
4141
TError,
4242
TData,
4343
TQueryKey,
4444
TPageParam
4545
>,
4646
injector?: Injector,
47-
): CreateInfiniteQueryResult<TData, TError>
47+
): DefinedCreateInfiniteQueryResult<TData, TError>
4848

4949
/**
5050
* Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
@@ -63,15 +63,15 @@ export function injectInfiniteQuery<
6363
>(
6464
optionsFn: (
6565
client: QueryClient,
66-
) => DefinedInitialDataInfiniteOptions<
66+
) => UndefinedInitialDataInfiniteOptions<
6767
TQueryFnData,
6868
TError,
6969
TData,
7070
TQueryKey,
7171
TPageParam
7272
>,
7373
injector?: Injector,
74-
): DefinedCreateInfiniteQueryResult<TData, TError>
74+
): CreateInfiniteQueryResult<TData, TError>
7575

7676
/**
7777
* Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.

‎packages/angular-query-experimental/src/query-options.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ export function queryOptions<
6060
TData = TQueryFnData,
6161
TQueryKey extends QueryKey = QueryKey,
6262
>(
63-
options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
64-
): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
63+
options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
64+
): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
6565
queryKey: DataTag<TQueryKey, TQueryFnData>
6666
}
6767

@@ -93,8 +93,8 @@ export function queryOptions<
9393
TData = TQueryFnData,
9494
TQueryKey extends QueryKey = QueryKey,
9595
>(
96-
options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
97-
): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
96+
options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
97+
): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
9898
queryKey: DataTag<TQueryKey, TQueryFnData>
9999
}
100100

‎packages/angular-query-experimental/tsconfig.json

+6
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,11 @@
1212
"target": "ES2022",
1313
"types": ["vitest/globals"]
1414
},
15+
"angularCompilerOptions": {
16+
"enableI18nLegacyMessageIdFormat": false,
17+
"strictInjectionParameters": true,
18+
"strictInputAccessModifiers": true,
19+
"strictTemplates": true
20+
},
1521
"include": ["src", "eslint.config.js", "vite.config.ts"]
1622
}

0 commit comments

Comments
 (0)