@tanstack/angular-query-experimental 5.59.20 → 5.60.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -6
- package/build/index.d.ts +680 -0
- package/build/index.js +616 -0
- package/build/index.js.map +1 -0
- package/package.json +13 -14
- package/src/create-base-query.ts +119 -0
- package/src/index.ts +28 -0
- package/src/infinite-query-options.ts +125 -0
- package/src/inject-infinite-query.ts +119 -0
- package/src/inject-is-fetching.ts +50 -0
- package/src/inject-is-mutating.ts +49 -0
- package/src/inject-mutation-state.ts +99 -0
- package/src/inject-mutation.ts +122 -0
- package/src/inject-queries.ts +243 -0
- package/src/inject-query-client.ts +27 -0
- package/src/inject-query.ts +207 -0
- package/src/providers.ts +344 -0
- package/src/query-options.ts +125 -0
- package/src/signal-proxy.ts +46 -0
- package/src/test-setup.ts +12 -0
- package/src/types.ts +328 -0
- package/src/util/assert-injector/assert-injector.test.ts +74 -0
- package/src/util/assert-injector/assert-injector.ts +81 -0
- package/src/util/create-injection-token/create-injection-token.test.ts +32 -0
- package/src/util/create-injection-token/create-injection-token.ts +183 -0
- package/src/util/index.ts +13 -0
- package/src/util/is-dev-mode/is-dev-mode.ts +3 -0
- package/src/util/lazy-init/lazy-init.ts +34 -0
- package/src/util/lazy-signal-initializer/lazy-signal-initializer.ts +23 -0
- package/build/README.md +0 -133
- package/build/esm2022/create-base-query.mjs +0 -62
- package/build/esm2022/index.mjs +0 -16
- package/build/esm2022/infinite-query-options.mjs +0 -12
- package/build/esm2022/inject-infinite-query.mjs +0 -15
- package/build/esm2022/inject-is-fetching.mjs +0 -38
- package/build/esm2022/inject-is-mutating.mjs +0 -37
- package/build/esm2022/inject-mutation-state.mjs +0 -47
- package/build/esm2022/inject-mutation.mjs +0 -51
- package/build/esm2022/inject-queries.mjs +0 -33
- package/build/esm2022/inject-query-client.mjs +0 -22
- package/build/esm2022/inject-query.mjs +0 -44
- package/build/esm2022/providers.mjs +0 -56
- package/build/esm2022/query-options.mjs +0 -26
- package/build/esm2022/signal-proxy.mjs +0 -38
- package/build/esm2022/tanstack-angular-query-experimental.mjs +0 -5
- package/build/esm2022/types.mjs +0 -3
- package/build/esm2022/util/assert-injector/assert-injector.mjs +0 -21
- package/build/esm2022/util/create-injection-token/create-injection-token.mjs +0 -61
- package/build/esm2022/util/index.mjs +0 -9
- package/build/esm2022/util/lazy-init/lazy-init.mjs +0 -31
- package/build/esm2022/util/lazy-signal-initializer/lazy-signal-initializer.mjs +0 -14
- package/build/fesm2022/tanstack-angular-query-experimental.mjs +0 -587
- package/build/fesm2022/tanstack-angular-query-experimental.mjs.map +0 -1
- package/build/rollup.d.ts +0 -605
package/build/rollup.d.ts
DELETED
|
@@ -1,605 +0,0 @@
|
|
|
1
|
-
import type { DataTag } from '@tanstack/query-core';
|
|
2
|
-
import type { DefaultError } from '@tanstack/query-core';
|
|
3
|
-
import type { DefinedInfiniteQueryObserverResult } from '@tanstack/query-core';
|
|
4
|
-
import type { DefinedQueryObserverResult } from '@tanstack/query-core';
|
|
5
|
-
import type { EnvironmentProviders } from '@angular/core';
|
|
6
|
-
import type { InfiniteData } from '@tanstack/query-core';
|
|
7
|
-
import type { InfiniteQueryObserverOptions } from '@tanstack/query-core';
|
|
8
|
-
import type { InfiniteQueryObserverResult } from '@tanstack/query-core';
|
|
9
|
-
import type { InitialDataFunction } from '@tanstack/query-core';
|
|
10
|
-
import { InjectOptions } from '@angular/core';
|
|
11
|
-
import { Injector } from '@angular/core';
|
|
12
|
-
import type { MutateFunction } from '@tanstack/query-core';
|
|
13
|
-
import type { Mutation } from '@tanstack/query-core';
|
|
14
|
-
import type { MutationFilters } from '@tanstack/query-core';
|
|
15
|
-
import type { MutationObserverOptions } from '@tanstack/query-core';
|
|
16
|
-
import type { MutationObserverResult } from '@tanstack/query-core';
|
|
17
|
-
import type { MutationState } from '@tanstack/query-core';
|
|
18
|
-
import type { OmitKeyof } from '@tanstack/query-core';
|
|
19
|
-
import type { Override } from '@tanstack/query-core';
|
|
20
|
-
import { Provider } from '@angular/core';
|
|
21
|
-
import type { QueriesPlaceholderDataFunction } from '@tanstack/query-core';
|
|
22
|
-
import type { QueryClient } from '@tanstack/query-core';
|
|
23
|
-
import type { QueryFilters } from '@tanstack/query-core';
|
|
24
|
-
import type { QueryFunction } from '@tanstack/query-core';
|
|
25
|
-
import type { QueryKey } from '@tanstack/query-core';
|
|
26
|
-
import type { QueryObserverOptions } from '@tanstack/query-core';
|
|
27
|
-
import type { QueryObserverResult } from '@tanstack/query-core';
|
|
28
|
-
import type { Signal } from '@angular/core';
|
|
29
|
-
import type { ThrowOnError } from '@tanstack/query-core';
|
|
30
|
-
|
|
31
|
-
/**
|
|
32
|
-
* @public
|
|
33
|
-
*/
|
|
34
|
-
export declare interface BaseMutationNarrowing<TData = unknown, TError = DefaultError, TVariables = unknown, TContext = unknown> {
|
|
35
|
-
isSuccess: SignalFunction<(this: CreateMutationResult<TData, TError, TVariables, TContext>) => this is CreateMutationResult<TData, TError, TVariables, TContext, CreateStatusBasedMutationResult<'success', TData, TError, TVariables, TContext>>>;
|
|
36
|
-
isError: SignalFunction<(this: CreateMutationResult<TData, TError, TVariables, TContext>) => this is CreateMutationResult<TData, TError, TVariables, TContext, CreateStatusBasedMutationResult<'error', TData, TError, TVariables, TContext>>>;
|
|
37
|
-
isPending: SignalFunction<(this: CreateMutationResult<TData, TError, TVariables, TContext>) => this is CreateMutationResult<TData, TError, TVariables, TContext, CreateStatusBasedMutationResult<'pending', TData, TError, TVariables, TContext>>>;
|
|
38
|
-
isIdle: SignalFunction<(this: CreateMutationResult<TData, TError, TVariables, TContext>) => this is CreateMutationResult<TData, TError, TVariables, TContext, CreateStatusBasedMutationResult<'idle', TData, TError, TVariables, TContext>>>;
|
|
39
|
-
}
|
|
40
|
-
|
|
41
|
-
/**
|
|
42
|
-
* @public
|
|
43
|
-
*/
|
|
44
|
-
export declare interface BaseQueryNarrowing<TData = unknown, TError = DefaultError> {
|
|
45
|
-
isSuccess: (this: CreateBaseQueryResult<TData, TError>) => this is CreateBaseQueryResult<TData, TError, CreateStatusBasedQueryResult<'success', TData, TError>>;
|
|
46
|
-
isError: (this: CreateBaseQueryResult<TData, TError>) => this is CreateBaseQueryResult<TData, TError, CreateStatusBasedQueryResult<'error', TData, TError>>;
|
|
47
|
-
isPending: (this: CreateBaseQueryResult<TData, TError>) => this is CreateBaseQueryResult<TData, TError, CreateStatusBasedQueryResult<'pending', TData, TError>>;
|
|
48
|
-
}
|
|
49
|
-
|
|
50
|
-
/**
|
|
51
|
-
* @public
|
|
52
|
-
*/
|
|
53
|
-
export declare type CreateBaseMutationResult<TData = unknown, TError = DefaultError, TVariables = unknown, TContext = unknown> = Override<MutationObserverResult<TData, TError, TVariables, TContext>, {
|
|
54
|
-
mutate: CreateMutateFunction<TData, TError, TVariables, TContext>;
|
|
55
|
-
}> & {
|
|
56
|
-
mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>;
|
|
57
|
-
};
|
|
58
|
-
|
|
59
|
-
/**
|
|
60
|
-
* @public
|
|
61
|
-
*/
|
|
62
|
-
export declare interface CreateBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> {
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
/**
|
|
66
|
-
* @public
|
|
67
|
-
*/
|
|
68
|
-
export declare type CreateBaseQueryResult<TData = unknown, TError = DefaultError, TState = QueryObserverResult<TData, TError>> = BaseQueryNarrowing<TData, TError> & MapToSignals<OmitKeyof<TState, keyof BaseQueryNarrowing, 'safely'>>;
|
|
69
|
-
|
|
70
|
-
/**
|
|
71
|
-
* @public
|
|
72
|
-
*/
|
|
73
|
-
export declare interface CreateInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> extends OmitKeyof<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>, 'suspense'> {
|
|
74
|
-
}
|
|
75
|
-
|
|
76
|
-
/**
|
|
77
|
-
* @public
|
|
78
|
-
*/
|
|
79
|
-
export declare type CreateInfiniteQueryResult<TData = unknown, TError = DefaultError> = MapToSignals<InfiniteQueryObserverResult<TData, TError>>;
|
|
80
|
-
|
|
81
|
-
/**
|
|
82
|
-
* @public
|
|
83
|
-
*/
|
|
84
|
-
export declare type CreateMutateAsyncFunction<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> = MutateFunction<TData, TError, TVariables, TContext>;
|
|
85
|
-
|
|
86
|
-
/**
|
|
87
|
-
* @public
|
|
88
|
-
*/
|
|
89
|
-
export declare type CreateMutateFunction<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> = (...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>) => void;
|
|
90
|
-
|
|
91
|
-
/**
|
|
92
|
-
* @public
|
|
93
|
-
*/
|
|
94
|
-
export declare interface CreateMutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> extends OmitKeyof<MutationObserverOptions<TData, TError, TVariables, TContext>, '_defaulted'> {
|
|
95
|
-
}
|
|
96
|
-
|
|
97
|
-
/**
|
|
98
|
-
* @public
|
|
99
|
-
*/
|
|
100
|
-
export declare type CreateMutationResult<TData = unknown, TError = DefaultError, TVariables = unknown, TContext = unknown, TState = CreateStatusBasedMutationResult<CreateBaseMutationResult['status'], TData, TError, TVariables, TContext>> = BaseMutationNarrowing<TData, TError, TVariables, TContext> & MapToSignals<OmitKeyof<TState, keyof BaseMutationNarrowing, 'safely'>>;
|
|
101
|
-
|
|
102
|
-
/**
|
|
103
|
-
* @public
|
|
104
|
-
*/
|
|
105
|
-
export declare interface CreateQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends OmitKeyof<CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, 'suspense'> {
|
|
106
|
-
}
|
|
107
|
-
|
|
108
|
-
/**
|
|
109
|
-
* @public
|
|
110
|
-
*/
|
|
111
|
-
export declare type CreateQueryResult<TData = unknown, TError = DefaultError> = CreateBaseQueryResult<TData, TError>;
|
|
112
|
-
|
|
113
|
-
/**
|
|
114
|
-
* @public
|
|
115
|
-
*/
|
|
116
|
-
declare type CreateStatusBasedMutationResult<TStatus extends CreateBaseMutationResult['status'], TData = unknown, TError = DefaultError, TVariables = unknown, TContext = unknown> = Extract<CreateBaseMutationResult<TData, TError, TVariables, TContext>, {
|
|
117
|
-
status: TStatus;
|
|
118
|
-
}>;
|
|
119
|
-
|
|
120
|
-
/**
|
|
121
|
-
* @public
|
|
122
|
-
*/
|
|
123
|
-
declare type CreateStatusBasedQueryResult<TStatus extends QueryObserverResult['status'], TData = unknown, TError = DefaultError> = Extract<QueryObserverResult<TData, TError>, {
|
|
124
|
-
status: TStatus;
|
|
125
|
-
}>;
|
|
126
|
-
|
|
127
|
-
/**
|
|
128
|
-
* @public
|
|
129
|
-
*/
|
|
130
|
-
export declare type DefinedCreateInfiniteQueryResult<TData = unknown, TError = DefaultError, TDefinedInfiniteQueryObserver = DefinedInfiniteQueryObserverResult<TData, TError>> = MapToSignals<TDefinedInfiniteQueryObserver>;
|
|
131
|
-
|
|
132
|
-
/**
|
|
133
|
-
* @public
|
|
134
|
-
*/
|
|
135
|
-
export declare type DefinedCreateQueryResult<TData = unknown, TError = DefaultError, TDefinedQueryObserver = DefinedQueryObserverResult<TData, TError>> = MapToSignals<TDefinedQueryObserver>;
|
|
136
|
-
|
|
137
|
-
/**
|
|
138
|
-
* @public
|
|
139
|
-
*/
|
|
140
|
-
export declare type DefinedInitialDataInfiniteOptions<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam> & {
|
|
141
|
-
initialData: NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>> | (() => NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>);
|
|
142
|
-
};
|
|
143
|
-
|
|
144
|
-
/**
|
|
145
|
-
* @public
|
|
146
|
-
*/
|
|
147
|
-
export declare type DefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
|
|
148
|
-
initialData: NonUndefinedGuard<TQueryFnData> | (() => NonUndefinedGuard<TQueryFnData>);
|
|
149
|
-
};
|
|
150
|
-
|
|
151
|
-
declare type GetOptions<T> = T extends {
|
|
152
|
-
queryFnData: infer TQueryFnData;
|
|
153
|
-
error?: infer TError;
|
|
154
|
-
data: infer TData;
|
|
155
|
-
} ? QueryObserverOptionsForCreateQueries<TQueryFnData, TError, TData> : T extends {
|
|
156
|
-
queryFnData: infer TQueryFnData;
|
|
157
|
-
error?: infer TError;
|
|
158
|
-
} ? QueryObserverOptionsForCreateQueries<TQueryFnData, TError> : T extends {
|
|
159
|
-
data: infer TData;
|
|
160
|
-
error?: infer TError;
|
|
161
|
-
} ? QueryObserverOptionsForCreateQueries<unknown, TError, TData> : T extends [infer TQueryFnData, infer TError, infer TData] ? QueryObserverOptionsForCreateQueries<TQueryFnData, TError, TData> : T extends [infer TQueryFnData, infer TError] ? QueryObserverOptionsForCreateQueries<TQueryFnData, TError> : T extends [infer TQueryFnData] ? QueryObserverOptionsForCreateQueries<TQueryFnData> : T extends {
|
|
162
|
-
queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey> | SkipTokenForUseQueries;
|
|
163
|
-
select: (data: any) => infer TData;
|
|
164
|
-
throwOnError?: ThrowOnError<any, infer TError, any, any>;
|
|
165
|
-
} ? QueryObserverOptionsForCreateQueries<TQueryFnData, unknown extends TError ? DefaultError : TError, unknown extends TData ? TQueryFnData : TData, TQueryKey> : QueryObserverOptionsForCreateQueries;
|
|
166
|
-
|
|
167
|
-
declare type GetResults<T> = T extends {
|
|
168
|
-
queryFnData: any;
|
|
169
|
-
error?: infer TError;
|
|
170
|
-
data: infer TData;
|
|
171
|
-
} ? QueryObserverResult<TData, TError> : T extends {
|
|
172
|
-
queryFnData: infer TQueryFnData;
|
|
173
|
-
error?: infer TError;
|
|
174
|
-
} ? QueryObserverResult<TQueryFnData, TError> : T extends {
|
|
175
|
-
data: infer TData;
|
|
176
|
-
error?: infer TError;
|
|
177
|
-
} ? QueryObserverResult<TData, TError> : T extends [any, infer TError, infer TData] ? QueryObserverResult<TData, TError> : T extends [infer TQueryFnData, infer TError] ? QueryObserverResult<TQueryFnData, TError> : T extends [infer TQueryFnData] ? QueryObserverResult<TQueryFnData> : T extends {
|
|
178
|
-
queryFn?: QueryFunction<infer TQueryFnData, any> | SkipTokenForUseQueries;
|
|
179
|
-
select: (data: any) => infer TData;
|
|
180
|
-
throwOnError?: ThrowOnError<any, infer TError, any, any>;
|
|
181
|
-
} ? QueryObserverResult<unknown extends TData ? TQueryFnData : TData, unknown extends TError ? DefaultError : TError> : QueryObserverResult;
|
|
182
|
-
|
|
183
|
-
/**
|
|
184
|
-
* Allows to share and re-use infinite query options in a type-safe way.
|
|
185
|
-
*
|
|
186
|
-
* The `queryKey` will be tagged with the type from `queryFn`.
|
|
187
|
-
* @param options - The infinite query options to tag with the type from `queryFn`.
|
|
188
|
-
* @returns The tagged infinite query options.
|
|
189
|
-
* @public
|
|
190
|
-
*/
|
|
191
|
-
export declare 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> & {
|
|
192
|
-
queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>>;
|
|
193
|
-
};
|
|
194
|
-
|
|
195
|
-
/**
|
|
196
|
-
* Allows to share and re-use infinite query options in a type-safe way.
|
|
197
|
-
*
|
|
198
|
-
* The `queryKey` will be tagged with the type from `queryFn`.
|
|
199
|
-
* @param options - The infinite query options to tag with the type from `queryFn`.
|
|
200
|
-
* @returns The tagged infinite query options.
|
|
201
|
-
* @public
|
|
202
|
-
*/
|
|
203
|
-
export declare 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> & {
|
|
204
|
-
queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>>;
|
|
205
|
-
};
|
|
206
|
-
|
|
207
|
-
/**
|
|
208
|
-
* Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
|
|
209
|
-
* Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll"
|
|
210
|
-
* @param optionsFn - A function that returns infinite query options.
|
|
211
|
-
* @param injector - The Angular injector to use.
|
|
212
|
-
* @returns The infinite query result.
|
|
213
|
-
* @public
|
|
214
|
-
*/
|
|
215
|
-
export declare 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>;
|
|
216
|
-
|
|
217
|
-
/**
|
|
218
|
-
* Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
|
|
219
|
-
* Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll"
|
|
220
|
-
* @param optionsFn - A function that returns infinite query options.
|
|
221
|
-
* @param injector - The Angular injector to use.
|
|
222
|
-
* @returns The infinite query result.
|
|
223
|
-
* @public
|
|
224
|
-
*/
|
|
225
|
-
export declare 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>;
|
|
226
|
-
|
|
227
|
-
/**
|
|
228
|
-
* Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
|
|
229
|
-
* Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll"
|
|
230
|
-
* @param optionsFn - A function that returns infinite query options.
|
|
231
|
-
* @param injector - The Angular injector to use.
|
|
232
|
-
* @returns The infinite query result.
|
|
233
|
-
* @public
|
|
234
|
-
*/
|
|
235
|
-
export declare 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>;
|
|
236
|
-
|
|
237
|
-
/**
|
|
238
|
-
* Injects a signal that tracks the number of queries that your application is loading or
|
|
239
|
-
* fetching in the background.
|
|
240
|
-
*
|
|
241
|
-
* Can be used for app-wide loading indicators
|
|
242
|
-
* @param filters - The filters to apply to the query.
|
|
243
|
-
* @param injector - The Angular injector to use.
|
|
244
|
-
* @returns signal with number of loading or fetching queries.
|
|
245
|
-
* @public
|
|
246
|
-
*/
|
|
247
|
-
export declare function injectIsFetching(filters?: QueryFilters, injector?: Injector): Signal<number>;
|
|
248
|
-
|
|
249
|
-
/**
|
|
250
|
-
* Injects a signal that tracks the number of mutations that your application is fetching.
|
|
251
|
-
*
|
|
252
|
-
* Can be used for app-wide loading indicators
|
|
253
|
-
* @param filters - The filters to apply to the query.
|
|
254
|
-
* @param injector - The Angular injector to use.
|
|
255
|
-
* @returns signal with number of fetching mutations.
|
|
256
|
-
* @public
|
|
257
|
-
*/
|
|
258
|
-
export declare function injectIsMutating(filters?: MutationFilters, injector?: Injector): Signal<number>;
|
|
259
|
-
|
|
260
|
-
/**
|
|
261
|
-
* Injects a mutation: an imperative function that can be invoked which typically performs server side effects.
|
|
262
|
-
*
|
|
263
|
-
* Unlike queries, mutations are not run automatically.
|
|
264
|
-
* @param optionsFn - A function that returns mutation options.
|
|
265
|
-
* @param injector - The Angular injector to use.
|
|
266
|
-
* @returns The mutation.
|
|
267
|
-
* @public
|
|
268
|
-
*/
|
|
269
|
-
export declare function injectMutation<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown>(optionsFn: (client: QueryClient) => CreateMutationOptions<TData, TError, TVariables, TContext>, injector?: Injector): CreateMutationResult<TData, TError, TVariables, TContext>;
|
|
270
|
-
|
|
271
|
-
/**
|
|
272
|
-
* Injects a signal that tracks the state of all mutations.
|
|
273
|
-
* @param mutationStateOptionsFn - A function that returns mutation state options.
|
|
274
|
-
* @param options - The Angular injector to use.
|
|
275
|
-
* @returns The signal that tracks the state of all mutations.
|
|
276
|
-
* @public
|
|
277
|
-
*/
|
|
278
|
-
export declare function injectMutationState<TResult = MutationState>(mutationStateOptionsFn?: () => MutationStateOptions<TResult>, options?: InjectMutationStateOptions): Signal<Array<TResult>>;
|
|
279
|
-
|
|
280
|
-
/**
|
|
281
|
-
* @public
|
|
282
|
-
*/
|
|
283
|
-
export declare interface InjectMutationStateOptions {
|
|
284
|
-
injector?: Injector;
|
|
285
|
-
}
|
|
286
|
-
|
|
287
|
-
/**
|
|
288
|
-
* @public
|
|
289
|
-
*/
|
|
290
|
-
export declare function injectQueries<T extends Array<any>, TCombinedResult = QueriesResults<T>>({ queries, ...options }: {
|
|
291
|
-
queries: Signal<[...QueriesOptions<T>]>;
|
|
292
|
-
combine?: (result: QueriesResults<T>) => TCombinedResult;
|
|
293
|
-
}, injector?: Injector): Signal<TCombinedResult>;
|
|
294
|
-
|
|
295
|
-
/**
|
|
296
|
-
* Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
|
|
297
|
-
*
|
|
298
|
-
* **Basic example**
|
|
299
|
-
* ```ts
|
|
300
|
-
* class ServiceOrComponent {
|
|
301
|
-
* query = injectQuery(() => ({
|
|
302
|
-
* queryKey: ['repoData'],
|
|
303
|
-
* queryFn: () =>
|
|
304
|
-
* this.#http.get<Response>('https://api.github.com/repos/tanstack/query'),
|
|
305
|
-
* }))
|
|
306
|
-
* }
|
|
307
|
-
* ```
|
|
308
|
-
*
|
|
309
|
-
* Similar to `computed` from Angular, the function passed to `injectQuery` will be run in the reactive context.
|
|
310
|
-
* In the example below, the query will be automatically enabled and executed when the filter signal changes
|
|
311
|
-
* to a truthy value. When the filter signal changes back to a falsy value, the query will be disabled.
|
|
312
|
-
*
|
|
313
|
-
* **Reactive example**
|
|
314
|
-
* ```ts
|
|
315
|
-
* class ServiceOrComponent {
|
|
316
|
-
* filter = signal('')
|
|
317
|
-
*
|
|
318
|
-
* todosQuery = injectQuery(() => ({
|
|
319
|
-
* queryKey: ['todos', this.filter()],
|
|
320
|
-
* queryFn: () => fetchTodos(this.filter()),
|
|
321
|
-
* // Signals can be combined with expressions
|
|
322
|
-
* enabled: !!this.filter(),
|
|
323
|
-
* }))
|
|
324
|
-
* }
|
|
325
|
-
* ```
|
|
326
|
-
* @param optionsFn - A function that returns query options.
|
|
327
|
-
* @param injector - The Angular injector to use.
|
|
328
|
-
* @returns The query result.
|
|
329
|
-
* @public
|
|
330
|
-
* @see https://tanstack.com/query/latest/docs/framework/angular/guides/queries
|
|
331
|
-
*/
|
|
332
|
-
export declare function injectQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(optionsFn: (client: QueryClient) => DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, injector?: Injector): DefinedCreateQueryResult<TData, TError>;
|
|
333
|
-
|
|
334
|
-
/**
|
|
335
|
-
* Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
|
|
336
|
-
*
|
|
337
|
-
* **Basic example**
|
|
338
|
-
* ```ts
|
|
339
|
-
* class ServiceOrComponent {
|
|
340
|
-
* query = injectQuery(() => ({
|
|
341
|
-
* queryKey: ['repoData'],
|
|
342
|
-
* queryFn: () =>
|
|
343
|
-
* this.#http.get<Response>('https://api.github.com/repos/tanstack/query'),
|
|
344
|
-
* }))
|
|
345
|
-
* }
|
|
346
|
-
* ```
|
|
347
|
-
*
|
|
348
|
-
* Similar to `computed` from Angular, the function passed to `injectQuery` will be run in the reactive context.
|
|
349
|
-
* In the example below, the query will be automatically enabled and executed when the filter signal changes
|
|
350
|
-
* to a truthy value. When the filter signal changes back to a falsy value, the query will be disabled.
|
|
351
|
-
*
|
|
352
|
-
* **Reactive example**
|
|
353
|
-
* ```ts
|
|
354
|
-
* class ServiceOrComponent {
|
|
355
|
-
* filter = signal('')
|
|
356
|
-
*
|
|
357
|
-
* todosQuery = injectQuery(() => ({
|
|
358
|
-
* queryKey: ['todos', this.filter()],
|
|
359
|
-
* queryFn: () => fetchTodos(this.filter()),
|
|
360
|
-
* // Signals can be combined with expressions
|
|
361
|
-
* enabled: !!this.filter(),
|
|
362
|
-
* }))
|
|
363
|
-
* }
|
|
364
|
-
* ```
|
|
365
|
-
* @param optionsFn - A function that returns query options.
|
|
366
|
-
* @param injector - The Angular injector to use.
|
|
367
|
-
* @returns The query result.
|
|
368
|
-
* @public
|
|
369
|
-
* @see https://tanstack.com/query/latest/docs/framework/angular/guides/queries
|
|
370
|
-
*/
|
|
371
|
-
export declare function injectQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(optionsFn: (client: QueryClient) => UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, injector?: Injector): CreateQueryResult<TData, TError>;
|
|
372
|
-
|
|
373
|
-
/**
|
|
374
|
-
* Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
|
|
375
|
-
*
|
|
376
|
-
* **Basic example**
|
|
377
|
-
* ```ts
|
|
378
|
-
* class ServiceOrComponent {
|
|
379
|
-
* query = injectQuery(() => ({
|
|
380
|
-
* queryKey: ['repoData'],
|
|
381
|
-
* queryFn: () =>
|
|
382
|
-
* this.#http.get<Response>('https://api.github.com/repos/tanstack/query'),
|
|
383
|
-
* }))
|
|
384
|
-
* }
|
|
385
|
-
* ```
|
|
386
|
-
*
|
|
387
|
-
* Similar to `computed` from Angular, the function passed to `injectQuery` will be run in the reactive context.
|
|
388
|
-
* In the example below, the query will be automatically enabled and executed when the filter signal changes
|
|
389
|
-
* to a truthy value. When the filter signal changes back to a falsy value, the query will be disabled.
|
|
390
|
-
*
|
|
391
|
-
* **Reactive example**
|
|
392
|
-
* ```ts
|
|
393
|
-
* class ServiceOrComponent {
|
|
394
|
-
* filter = signal('')
|
|
395
|
-
*
|
|
396
|
-
* todosQuery = injectQuery(() => ({
|
|
397
|
-
* queryKey: ['todos', this.filter()],
|
|
398
|
-
* queryFn: () => fetchTodos(this.filter()),
|
|
399
|
-
* // Signals can be combined with expressions
|
|
400
|
-
* enabled: !!this.filter(),
|
|
401
|
-
* }))
|
|
402
|
-
* }
|
|
403
|
-
* ```
|
|
404
|
-
* @param optionsFn - A function that returns query options.
|
|
405
|
-
* @param injector - The Angular injector to use.
|
|
406
|
-
* @returns The query result.
|
|
407
|
-
* @public
|
|
408
|
-
* @see https://tanstack.com/query/latest/docs/framework/angular/guides/queries
|
|
409
|
-
*/
|
|
410
|
-
export declare function injectQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(optionsFn: (client: QueryClient) => CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>, injector?: Injector): CreateQueryResult<TData, TError>;
|
|
411
|
-
|
|
412
|
-
/**
|
|
413
|
-
* Injects the `QueryClient` instance into the component or service.
|
|
414
|
-
*
|
|
415
|
-
* **Example**
|
|
416
|
-
* ```ts
|
|
417
|
-
* const queryClient = injectQueryClient();
|
|
418
|
-
* ```
|
|
419
|
-
* @returns The `QueryClient` instance.
|
|
420
|
-
* @public
|
|
421
|
-
*/
|
|
422
|
-
export declare const injectQueryClient: {
|
|
423
|
-
(): QueryClient;
|
|
424
|
-
(injectOptions: InjectOptions & {
|
|
425
|
-
optional?: false;
|
|
426
|
-
} & {
|
|
427
|
-
injector?: Injector;
|
|
428
|
-
}): QueryClient;
|
|
429
|
-
(injectOptions: InjectOptions & {
|
|
430
|
-
injector?: Injector;
|
|
431
|
-
}): QueryClient;
|
|
432
|
-
};
|
|
433
|
-
|
|
434
|
-
declare type MapToSignals<T> = {
|
|
435
|
-
[K in keyof T]: T[K] extends Function ? T[K] : Signal<T[K]>;
|
|
436
|
-
};
|
|
437
|
-
|
|
438
|
-
declare type MAXIMUM_DEPTH = 20;
|
|
439
|
-
|
|
440
|
-
declare type MutationStateOptions<TResult = MutationState> = {
|
|
441
|
-
filters?: MutationFilters;
|
|
442
|
-
select?: (mutation: Mutation) => TResult;
|
|
443
|
-
};
|
|
444
|
-
|
|
445
|
-
/**
|
|
446
|
-
* @public
|
|
447
|
-
*/
|
|
448
|
-
export declare type NonUndefinedGuard<T> = T extends undefined ? never : T;
|
|
449
|
-
|
|
450
|
-
/**
|
|
451
|
-
* Sets up providers necessary to enable TanStack Query functionality for Angular applications.
|
|
452
|
-
*
|
|
453
|
-
* Allows to configure a `QueryClient`.
|
|
454
|
-
*
|
|
455
|
-
* **Example - standalone**
|
|
456
|
-
*
|
|
457
|
-
* ```ts
|
|
458
|
-
* import {
|
|
459
|
-
* provideAngularQuery,
|
|
460
|
-
* QueryClient,
|
|
461
|
-
* } from '@tanstack/angular-query-experimental'
|
|
462
|
-
*
|
|
463
|
-
* bootstrapApplication(AppComponent, {
|
|
464
|
-
* providers: [provideAngularQuery(new QueryClient())],
|
|
465
|
-
* })
|
|
466
|
-
* ```
|
|
467
|
-
*
|
|
468
|
-
* **Example - NgModule-based**
|
|
469
|
-
*
|
|
470
|
-
* ```ts
|
|
471
|
-
* import {
|
|
472
|
-
* provideAngularQuery,
|
|
473
|
-
* QueryClient,
|
|
474
|
-
* } from '@tanstack/angular-query-experimental'
|
|
475
|
-
*
|
|
476
|
-
* @NgModule({
|
|
477
|
-
* declarations: [AppComponent],
|
|
478
|
-
* imports: [BrowserModule],
|
|
479
|
-
* providers: [provideAngularQuery(new QueryClient())],
|
|
480
|
-
* bootstrap: [AppComponent],
|
|
481
|
-
* })
|
|
482
|
-
* export class AppModule {}
|
|
483
|
-
* ```
|
|
484
|
-
* @param queryClient - A `QueryClient` instance.
|
|
485
|
-
* @returns A set of providers to set up TanStack Query.
|
|
486
|
-
* @public
|
|
487
|
-
* @see https://tanstack.com/query/v5/docs/framework/angular/quick-start
|
|
488
|
-
*/
|
|
489
|
-
export declare function provideAngularQuery(queryClient: QueryClient): EnvironmentProviders;
|
|
490
|
-
|
|
491
|
-
/**
|
|
492
|
-
* Usually {@link provideAngularQuery} is used once to set up TanStack Query and the
|
|
493
|
-
* {@link https://tanstack.com/query/latest/docs/reference/QueryClient|QueryClient}
|
|
494
|
-
* for the entire application. You can use `provideQueryClient` to provide a
|
|
495
|
-
* different `QueryClient` instance for a part of the application.
|
|
496
|
-
* @public
|
|
497
|
-
*/
|
|
498
|
-
export declare const provideQueryClient: ((value: QueryClient | (() => QueryClient)) => Provider) & ((value: QueryClient | (() => QueryClient)) => Provider);
|
|
499
|
-
|
|
500
|
-
/**
|
|
501
|
-
* QueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
|
|
502
|
-
* @public
|
|
503
|
-
*/
|
|
504
|
-
export declare type QueriesOptions<T extends Array<any>, TResult extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array<QueryObserverOptionsForCreateQueries> : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetOptions<Head>] : T extends [infer Head, ...infer Tail] ? QueriesOptions<[
|
|
505
|
-
...Tail
|
|
506
|
-
], [
|
|
507
|
-
...TResult,
|
|
508
|
-
GetOptions<Head>
|
|
509
|
-
], [
|
|
510
|
-
...TDepth,
|
|
511
|
-
1
|
|
512
|
-
]> : ReadonlyArray<unknown> extends T ? T : T extends Array<QueryObserverOptionsForCreateQueries<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>> ? Array<QueryObserverOptionsForCreateQueries<TQueryFnData, TError, TData, TQueryKey>> : Array<QueryObserverOptionsForCreateQueries>;
|
|
513
|
-
|
|
514
|
-
/**
|
|
515
|
-
* QueriesResults reducer recursively maps type param to results
|
|
516
|
-
* @public
|
|
517
|
-
*/
|
|
518
|
-
export declare type QueriesResults<T extends Array<any>, TResult extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array<QueryObserverResult> : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetResults<Head>] : T extends [infer Head, ...infer Tail] ? QueriesResults<[
|
|
519
|
-
...Tail
|
|
520
|
-
], [
|
|
521
|
-
...TResult,
|
|
522
|
-
GetResults<Head>
|
|
523
|
-
], [
|
|
524
|
-
...TDepth,
|
|
525
|
-
1
|
|
526
|
-
]> : 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>;
|
|
527
|
-
|
|
528
|
-
declare type QueryObserverOptionsForCreateQueries<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = OmitKeyof<QueryObserverOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, 'placeholderData'> & {
|
|
529
|
-
placeholderData?: TQueryFnData | QueriesPlaceholderDataFunction<TQueryFnData>;
|
|
530
|
-
};
|
|
531
|
-
|
|
532
|
-
/**
|
|
533
|
-
* Allows to share and re-use query options in a type-safe way.
|
|
534
|
-
*
|
|
535
|
-
* The `queryKey` will be tagged with the type from `queryFn`.
|
|
536
|
-
*
|
|
537
|
-
* **Example**
|
|
538
|
-
*
|
|
539
|
-
* ```ts
|
|
540
|
-
* const { queryKey } = queryOptions({
|
|
541
|
-
* queryKey: ['key'],
|
|
542
|
-
* queryFn: () => Promise.resolve(5),
|
|
543
|
-
* // ^? Promise<number>
|
|
544
|
-
* })
|
|
545
|
-
*
|
|
546
|
-
* const queryClient = new QueryClient()
|
|
547
|
-
* const data = queryClient.getQueryData(queryKey)
|
|
548
|
-
* // ^? number | undefined
|
|
549
|
-
* ```
|
|
550
|
-
* @param options - The query options to tag with the type from `queryFn`.
|
|
551
|
-
* @returns The tagged query options.
|
|
552
|
-
* @public
|
|
553
|
-
*/
|
|
554
|
-
export declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
|
|
555
|
-
queryKey: DataTag<TQueryKey, TQueryFnData>;
|
|
556
|
-
};
|
|
557
|
-
|
|
558
|
-
/**
|
|
559
|
-
* Allows to share and re-use query options in a type-safe way.
|
|
560
|
-
*
|
|
561
|
-
* The `queryKey` will be tagged with the type from `queryFn`.
|
|
562
|
-
*
|
|
563
|
-
* **Example**
|
|
564
|
-
*
|
|
565
|
-
* ```ts
|
|
566
|
-
* const { queryKey } = queryOptions({
|
|
567
|
-
* queryKey: ['key'],
|
|
568
|
-
* queryFn: () => Promise.resolve(5),
|
|
569
|
-
* // ^? Promise<number>
|
|
570
|
-
* })
|
|
571
|
-
*
|
|
572
|
-
* const queryClient = new QueryClient()
|
|
573
|
-
* const data = queryClient.getQueryData(queryKey)
|
|
574
|
-
* // ^? number | undefined
|
|
575
|
-
* ```
|
|
576
|
-
* @param options - The query options to tag with the type from `queryFn`.
|
|
577
|
-
* @returns The tagged query options.
|
|
578
|
-
* @public
|
|
579
|
-
*/
|
|
580
|
-
export declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
|
|
581
|
-
queryKey: DataTag<TQueryKey, TQueryFnData>;
|
|
582
|
-
};
|
|
583
|
-
|
|
584
|
-
declare type SignalFunction<T extends () => any> = T & Signal<ReturnType<T>>;
|
|
585
|
-
|
|
586
|
-
declare type SkipTokenForUseQueries = symbol;
|
|
587
|
-
|
|
588
|
-
/**
|
|
589
|
-
* @public
|
|
590
|
-
*/
|
|
591
|
-
export declare type UndefinedInitialDataInfiniteOptions<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam> & {
|
|
592
|
-
initialData?: undefined;
|
|
593
|
-
};
|
|
594
|
-
|
|
595
|
-
/**
|
|
596
|
-
* @public
|
|
597
|
-
*/
|
|
598
|
-
export declare type UndefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
|
|
599
|
-
initialData?: undefined | InitialDataFunction<NonUndefinedGuard<TQueryFnData>>;
|
|
600
|
-
};
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
export * from "@tanstack/query-core";
|
|
604
|
-
|
|
605
|
-
export { }
|