Skip to content

Commit 20c36c8

Browse files
autofix-ci[bot]autofix-ci[bot]
authored
ci: apply automated fixes
1 parent afc6302 commit 20c36c8

75 files changed

Lines changed: 660 additions & 226 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/framework/angular/reference/functions/infinitequeryoptions.md‎

Lines changed: 51 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,22 @@ The infinite query options to tag with the type from `queryFn`.
1616
## Call Signature
1717

1818
```ts
19-
function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object
19+
function infiniteQueryOptions<
20+
TQueryFnData,
21+
TError,
22+
TData,
23+
TQueryKey,
24+
TPageParam,
25+
>(
26+
options,
27+
): DefinedInitialDataInfiniteOptions<
28+
TQueryFnData,
29+
TError,
30+
TData,
31+
TQueryKey,
32+
TPageParam
33+
> &
34+
object
2035
```
2136

2237
Allows to share and re-use infinite query options in a type-safe way.
@@ -31,7 +46,7 @@ The `queryKey` will be tagged with the type from `queryFn`.
3146

3247
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
3348

34-
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
49+
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
3550

3651
• **TPageParam** = `unknown`
3752

@@ -62,7 +77,22 @@ The infinite query options to tag with the type from `queryFn`.
6277
## Call Signature
6378

6479
```ts
65-
function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): UnusedSkipTokenInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object
80+
function infiniteQueryOptions<
81+
TQueryFnData,
82+
TError,
83+
TData,
84+
TQueryKey,
85+
TPageParam,
86+
>(
87+
options,
88+
): UnusedSkipTokenInfiniteOptions<
89+
TQueryFnData,
90+
TError,
91+
TData,
92+
TQueryKey,
93+
TPageParam
94+
> &
95+
object
6696
```
6797

6898
Allows to share and re-use infinite query options in a type-safe way.
@@ -77,7 +107,7 @@ The `queryKey` will be tagged with the type from `queryFn`.
77107

78108
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
79109

80-
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
110+
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
81111

82112
• **TPageParam** = `unknown`
83113

@@ -108,7 +138,22 @@ The infinite query options to tag with the type from `queryFn`.
108138
## Call Signature
109139

110140
```ts
111-
function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object
141+
function infiniteQueryOptions<
142+
TQueryFnData,
143+
TError,
144+
TData,
145+
TQueryKey,
146+
TPageParam,
147+
>(
148+
options,
149+
): UndefinedInitialDataInfiniteOptions<
150+
TQueryFnData,
151+
TError,
152+
TData,
153+
TQueryKey,
154+
TPageParam
155+
> &
156+
object
112157
```
113158

114159
Allows to share and re-use infinite query options in a type-safe way.
@@ -123,7 +168,7 @@ The `queryKey` will be tagged with the type from `queryFn`.
123168

124169
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
125170

126-
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
171+
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
127172

128173
• **TPageParam** = `unknown`
129174

‎docs/framework/angular/reference/functions/injectinfinitequery.md‎

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,16 @@ Additional configuration.
1919
## Call Signature
2020

2121
```ts
22-
function injectInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(injectInfiniteQueryFn, options?): DefinedCreateInfiniteQueryResult<TData, TError>
22+
function injectInfiniteQuery<
23+
TQueryFnData,
24+
TError,
25+
TData,
26+
TQueryKey,
27+
TPageParam,
28+
>(
29+
injectInfiniteQueryFn,
30+
options?,
31+
): DefinedCreateInfiniteQueryResult<TData, TError>
2332
```
2433

2534
Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
@@ -33,7 +42,7 @@ Infinite queries can additively "load more" data onto an existing set of data or
3342

3443
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
3544

36-
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
45+
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
3746

3847
• **TPageParam** = `unknown`
3948

@@ -74,7 +83,13 @@ Additional configuration.
7483
## Call Signature
7584

7685
```ts
77-
function injectInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult<TData, TError>
86+
function injectInfiniteQuery<
87+
TQueryFnData,
88+
TError,
89+
TData,
90+
TQueryKey,
91+
TPageParam,
92+
>(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult<TData, TError>
7893
```
7994

8095
Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
@@ -88,7 +103,7 @@ Infinite queries can additively "load more" data onto an existing set of data or
88103

89104
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
90105

91-
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
106+
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
92107

93108
• **TPageParam** = `unknown`
94109

@@ -129,7 +144,13 @@ Additional configuration.
129144
## Call Signature
130145

131146
```ts
132-
function injectInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult<TData, TError>
147+
function injectInfiniteQuery<
148+
TQueryFnData,
149+
TError,
150+
TData,
151+
TQueryKey,
152+
TPageParam,
153+
>(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult<TData, TError>
133154
```
134155

135156
Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
@@ -143,7 +164,7 @@ Infinite queries can additively "load more" data onto an existing set of data or
143164

144165
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
145166

146-
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
167+
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
147168

148169
• **TPageParam** = `unknown`
149170

‎docs/framework/angular/reference/functions/injectmutation.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@ title: injectMutation
66
# Function: injectMutation()
77

88
```ts
9-
function injectMutation<TData, TError, TVariables, TContext>(injectMutationFn, options?): CreateMutationResult<TData, TError, TVariables, TContext>
9+
function injectMutation<TData, TError, TVariables, TContext>(
10+
injectMutationFn,
11+
options?,
12+
): CreateMutationResult<TData, TError, TVariables, TContext>
1013
```
1114

1215
Injects a mutation: an imperative function that can be invoked which typically performs server side effects.

‎docs/framework/angular/reference/functions/injectmutationstate.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@ title: injectMutationState
66
# Function: injectMutationState()
77

88
```ts
9-
function injectMutationState<TResult>(injectMutationStateFn, options?): Signal<TResult[]>
9+
function injectMutationState<TResult>(
10+
injectMutationStateFn,
11+
options?,
12+
): Signal<TResult[]>
1013
```
1114

1215
Injects a signal that tracks the state of all mutations.

‎docs/framework/angular/reference/functions/injectqueries.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,17 @@ title: injectQueries
66
# Function: injectQueries()
77

88
```ts
9-
function injectQueries<T, TCombinedResult>(__namedParameters, injector?): Signal<TCombinedResult>
9+
function injectQueries<T, TCombinedResult>(
10+
__namedParameters,
11+
injector?,
12+
): Signal<TCombinedResult>
1013
```
1114

1215
## Type Parameters
1316

14-
• **T** *extends* `any`[]
17+
• **T** _extends_ `any`[]
1518

16-
• **TCombinedResult** = `T` *extends* [] ? [] : `T` *extends* [`Head`] ? [`GetResults`\<`Head`\>] : `T` *extends* [`Head`, `...Tail[]`] ? [`...Tail[]`] *extends* [] ? [] : [`...Tail[]`] *extends* [`Head`] ? [`GetResults`\<`Head`\>, `GetResults`\<`Head`\>] : [`...Tail[]`] *extends* [`Head`, `...Tail[]`] ? [`...Tail[]`] *extends* [] ? [] : [`...Tail[]`] *extends* [`Head`] ? [`GetResults`\<`Head`\>, `GetResults`\<`Head`\>, `GetResults`\<`Head`\>] : [`...Tail[]`] *extends* [`Head`, `...Tail[]`] ? [`...(...)[]`] *extends* [] ? [] : ... *extends* ... ? ... : ... : [`...(...)[]`] *extends* ...[] ? ...[] : ...[] : [`...Tail[]`] *extends* `QueryObserverOptionsForCreateQueries`\<`TQueryFnData`, `TError`, `TData`, `any`\>[] ? `QueryObserverResult`\<`unknown` *extends* `TData` ? `TQueryFnData` : `TData`, `unknown` *extends* `TError` ? `Error` : `TError`\>[] : `QueryObserverResult`[] : `T` *extends* `QueryObserverOptionsForCreateQueries`\<`TQueryFnData`, `TError`, `TData`, `any`\>[] ? `QueryObserverResult`\<`unknown` *extends* `TData` ? `TQueryFnData` : `TData`, `unknown` *extends* `TError` ? `Error` : `TError`\>[] : `QueryObserverResult`[]
19+
• **TCombinedResult** = `T` _extends_ [] ? [] : `T` _extends_ [`Head`] ? [`GetResults`\<`Head`\>] : `T` _extends_ [`Head`, `...Tail[]`] ? [`...Tail[]`] _extends_ [] ? [] : [`...Tail[]`] _extends_ [`Head`] ? [`GetResults`\<`Head`\>, `GetResults`\<`Head`\>] : [`...Tail[]`] _extends_ [`Head`, `...Tail[]`] ? [`...Tail[]`] _extends_ [] ? [] : [`...Tail[]`] _extends_ [`Head`] ? [`GetResults`\<`Head`\>, `GetResults`\<`Head`\>, `GetResults`\<`Head`\>] : [`...Tail[]`] _extends_ [`Head`, `...Tail[]`] ? [`...(...)[]`] _extends_ [] ? [] : ... _extends_ ... ? ... : ... : [`...(...)[]`] _extends_ ...[] ? ...[] : ...[] : [`...Tail[]`] _extends_ `QueryObserverOptionsForCreateQueries`\<`TQueryFnData`, `TError`, `TData`, `any`\>[] ? `QueryObserverResult`\<`unknown` _extends_ `TData` ? `TQueryFnData` : `TData`, `unknown` _extends_ `TError` ? `Error` : `TError`\>[] : `QueryObserverResult`[] : `T` _extends_ `QueryObserverOptionsForCreateQueries`\<`TQueryFnData`, `TError`, `TData`, `any`\>[] ? `QueryObserverResult`\<`unknown` _extends_ `TData` ? `TQueryFnData` : `TData`, `unknown` _extends_ `TError` ? `Error` : `TError`\>[] : `QueryObserverResult`[]
1720

1821
## Parameters
1922

‎docs/framework/angular/reference/functions/injectquery.md‎

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ title: injectQuery
88
Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
99

1010
**Basic example**
11+
1112
```ts
1213
class ServiceOrComponent {
1314
query = injectQuery(() => ({
@@ -23,6 +24,7 @@ In the example below, the query will be automatically enabled and executed when
2324
to a truthy value. When the filter signal changes back to a falsy value, the query will be disabled.
2425

2526
**Reactive example**
27+
2628
```ts
2729
class ServiceOrComponent {
2830
filter = signal('')
@@ -51,12 +53,16 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries
5153
## Call Signature
5254

5355
```ts
54-
function injectQuery<TQueryFnData, TError, TData, TQueryKey>(injectQueryFn, options?): DefinedCreateQueryResult<TData, TError>
56+
function injectQuery<TQueryFnData, TError, TData, TQueryKey>(
57+
injectQueryFn,
58+
options?,
59+
): DefinedCreateQueryResult<TData, TError>
5560
```
5661

5762
Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
5863

5964
**Basic example**
65+
6066
```ts
6167
class ServiceOrComponent {
6268
query = injectQuery(() => ({
@@ -72,6 +78,7 @@ In the example below, the query will be automatically enabled and executed when
7278
to a truthy value. When the filter signal changes back to a falsy value, the query will be disabled.
7379

7480
**Reactive example**
81+
7582
```ts
7683
class ServiceOrComponent {
7784
filter = signal('')
@@ -93,7 +100,7 @@ class ServiceOrComponent {
93100

94101
• **TData** = `TQueryFnData`
95102

96-
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
103+
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
97104

98105
### Parameters
99106

@@ -140,12 +147,16 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries
140147
## Call Signature
141148

142149
```ts
143-
function injectQuery<TQueryFnData, TError, TData, TQueryKey>(injectQueryFn, options?): CreateQueryResult<TData, TError>
150+
function injectQuery<TQueryFnData, TError, TData, TQueryKey>(
151+
injectQueryFn,
152+
options?,
153+
): CreateQueryResult<TData, TError>
144154
```
145155

146156
Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
147157

148158
**Basic example**
159+
149160
```ts
150161
class ServiceOrComponent {
151162
query = injectQuery(() => ({
@@ -161,6 +172,7 @@ In the example below, the query will be automatically enabled and executed when
161172
to a truthy value. When the filter signal changes back to a falsy value, the query will be disabled.
162173

163174
**Reactive example**
175+
164176
```ts
165177
class ServiceOrComponent {
166178
filter = signal('')
@@ -182,7 +194,7 @@ class ServiceOrComponent {
182194

183195
• **TData** = `TQueryFnData`
184196

185-
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
197+
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
186198

187199
### Parameters
188200

@@ -229,12 +241,16 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries
229241
## Call Signature
230242

231243
```ts
232-
function injectQuery<TQueryFnData, TError, TData, TQueryKey>(injectQueryFn, options?): CreateQueryResult<TData, TError>
244+
function injectQuery<TQueryFnData, TError, TData, TQueryKey>(
245+
injectQueryFn,
246+
options?,
247+
): CreateQueryResult<TData, TError>
233248
```
234249

235250
Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
236251

237252
**Basic example**
253+
238254
```ts
239255
class ServiceOrComponent {
240256
query = injectQuery(() => ({
@@ -250,6 +266,7 @@ In the example below, the query will be automatically enabled and executed when
250266
to a truthy value. When the filter signal changes back to a falsy value, the query will be disabled.
251267

252268
**Reactive example**
269+
253270
```ts
254271
class ServiceOrComponent {
255272
filter = signal('')
@@ -271,7 +288,7 @@ class ServiceOrComponent {
271288

272289
• **TData** = `TQueryFnData`
273290

274-
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
291+
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
275292

276293
### Parameters
277294

‎docs/framework/angular/reference/functions/injectqueryclient.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,9 @@ Use `inject(QueryClient)` instead.
3131
If you need to get a `QueryClient` from a custom injector, use `injector.get(QueryClient)`.
3232

3333
**Example**
34+
3435
```ts
35-
const queryClient = injectQueryClient();
36+
const queryClient = injectQueryClient()
3637
```
3738

3839
## Defined in

‎docs/framework/angular/reference/functions/mutationoptions.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ title: mutationOptions
66
# Function: mutationOptions()
77

88
```ts
9-
function mutationOptions<TData, TError, TVariables, TContext>(options): CreateMutationOptions<TData, TError, TVariables, TContext>
9+
function mutationOptions<TData, TError, TVariables, TContext>(
10+
options,
11+
): CreateMutationOptions<TData, TError, TVariables, TContext>
1012
```
1113

1214
Allows to share and re-use mutation options in a type-safe way.
@@ -15,22 +17,22 @@ Allows to share and re-use mutation options in a type-safe way.
1517

1618
```ts
1719
export class QueriesService {
18-
private http = inject(HttpClient);
20+
private http = inject(HttpClient)
1921
2022
updatePost(id: number) {
2123
return mutationOptions({
2224
mutationFn: (post: Post) => Promise.resolve(post),
23-
mutationKey: ["updatePost", id],
25+
mutationKey: ['updatePost', id],
2426
onSuccess: (newPost) => {
2527
// ^? newPost: Post
26-
this.queryClient.setQueryData(["posts", id], newPost);
28+
this.queryClient.setQueryData(['posts', id], newPost)
2729
},
28-
});
30+
})
2931
}
3032
}
3133
3234
queries = inject(QueriesService)
33-
idSignal = new Signal(0);
35+
idSignal = new Signal(0)
3436
mutation = injectMutation(() => this.queries.updatePost(this.idSignal()))
3537
3638
mutation.mutate({ title: 'New Title' })

0 commit comments

Comments
 (0)