Skip to content

Commit 59f67b5

Browse files
update tanstack config
1 parent a16dc55 commit 59f67b5

File tree

85 files changed

+599
-670
lines changed

Some content is hidden

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

85 files changed

+599
-670
lines changed

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

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ id: infiniteQueryOptions
33
title: infiniteQueryOptions
44
---
55

6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
68
# Function: infiniteQueryOptions()
79

810
Allows to share and re-use infinite query options in a type-safe way.
@@ -34,6 +36,8 @@ function infiniteQueryOptions<
3436
object
3537
```
3638

39+
Defined in: [infinite-query-options.ts:59](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L59)
40+
3741
Allows to share and re-use infinite query options in a type-safe way.
3842

3943
The `queryKey` will be tagged with the type from `queryFn`.
@@ -44,7 +48,7 @@ The `queryKey` will be tagged with the type from `queryFn`.
4448

4549
**TError** = `Error`
4650

47-
**TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
51+
**TData** = `InfiniteData`\<`TQueryFnData`\>
4852

4953
**TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
5054

@@ -70,10 +74,6 @@ The tagged infinite query options.
7074

7175
The infinite query options to tag with the type from `queryFn`.
7276

73-
### Defined in
74-
75-
[infinite-query-options.ts:59](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L59)
76-
7777
## Call Signature
7878

7979
```ts
@@ -95,6 +95,8 @@ function infiniteQueryOptions<
9595
object
9696
```
9797

98+
Defined in: [infinite-query-options.ts:91](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L91)
99+
98100
Allows to share and re-use infinite query options in a type-safe way.
99101

100102
The `queryKey` will be tagged with the type from `queryFn`.
@@ -105,7 +107,7 @@ The `queryKey` will be tagged with the type from `queryFn`.
105107

106108
**TError** = `Error`
107109

108-
**TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
110+
**TData** = `InfiniteData`\<`TQueryFnData`\>
109111

110112
**TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
111113

@@ -130,7 +132,3 @@ The tagged infinite query options.
130132
### Param
131133

132134
The infinite query options to tag with the type from `queryFn`.
133-
134-
### Defined in
135-
136-
[infinite-query-options.ts:91](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L91)

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

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ id: injectInfiniteQuery
33
title: injectInfiniteQuery
44
---
55

6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
68
# Function: injectInfiniteQuery()
79

810
Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
@@ -28,6 +30,8 @@ function injectInfiniteQuery<
2830
>(optionsFn, injector?): DefinedCreateInfiniteQueryResult<TData, TError>
2931
```
3032

33+
Defined in: [inject-infinite-query.ts:29](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L29)
34+
3135
Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
3236
Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll"
3337

@@ -37,7 +41,7 @@ Infinite queries can additively "load more" data onto an existing set of data or
3741

3842
**TError** = `Error`
3943

40-
**TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
44+
**TData** = `InfiniteData`\<`TQueryFnData`\>
4145

4246
**TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
4347

@@ -73,10 +77,6 @@ A function that returns infinite query options.
7377

7478
The Angular injector to use.
7579

76-
### Defined in
77-
78-
[inject-infinite-query.ts:29](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L29)
79-
8080
## Call Signature
8181

8282
```ts
@@ -89,6 +89,8 @@ function injectInfiniteQuery<
8989
>(optionsFn, injector?): CreateInfiniteQueryResult<TData, TError>
9090
```
9191

92+
Defined in: [inject-infinite-query.ts:54](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L54)
93+
9294
Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
9395
Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll"
9496

@@ -98,7 +100,7 @@ Infinite queries can additively "load more" data onto an existing set of data or
98100

99101
• **TError** = `Error`
100102

101-
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
103+
• **TData** = `InfiniteData`\<`TQueryFnData`\>
102104

103105
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
104106

@@ -134,10 +136,6 @@ A function that returns infinite query options.
134136

135137
The Angular injector to use.
136138

137-
### Defined in
138-
139-
[inject-infinite-query.ts:54](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L54)
140-
141139
## Call Signature
142140

143141
```ts
@@ -150,6 +148,8 @@ function injectInfiniteQuery<
150148
>(optionsFn, injector?): CreateInfiniteQueryResult<TData, TError>
151149
```
152150

151+
Defined in: [inject-infinite-query.ts:79](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L79)
152+
153153
Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
154154
Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll"
155155

@@ -159,7 +159,7 @@ Infinite queries can additively "load more" data onto an existing set of data or
159159

160160
• **TError** = `Error`
161161

162-
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
162+
• **TData** = `InfiniteData`\<`TQueryFnData`\>
163163

164164
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
165165

@@ -194,7 +194,3 @@ A function that returns infinite query options.
194194
### Param
195195

196196
The Angular injector to use.
197-
198-
### Defined in
199-
200-
[inject-infinite-query.ts:79](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L79)

docs/framework/angular/reference/functions/injectisfetching.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,16 @@ id: injectIsFetching
33
title: injectIsFetching
44
---
55

6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
68
# Function: injectIsFetching()
79

810
```ts
911
function injectIsFetching(filters?, injector?): Signal<number>
1012
```
1113

14+
Defined in: [inject-is-fetching.ts:17](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-fetching.ts#L17)
15+
1216
Injects a signal that tracks the number of queries that your application is loading or
1317
fetching in the background.
1418

@@ -18,7 +22,7 @@ Can be used for app-wide loading indicators
1822

1923
### filters?
2024

21-
`QueryFilters`\<`unknown`, `Error`, `unknown`, readonly `unknown`[]\>
25+
`QueryFilters`
2226

2327
The filters to apply to the query.
2428

@@ -33,7 +37,3 @@ The Angular injector to use.
3337
`Signal`\<`number`\>
3438

3539
signal with number of loading or fetching queries.
36-
37-
## Defined in
38-
39-
[inject-is-fetching.ts:17](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-fetching.ts#L17)

docs/framework/angular/reference/functions/injectismutating.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,16 @@ id: injectIsMutating
33
title: injectIsMutating
44
---
55

6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
68
# Function: injectIsMutating()
79

810
```ts
911
function injectIsMutating(filters?, injector?): Signal<number>
1012
```
1113

14+
Defined in: [inject-is-mutating.ts:16](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-mutating.ts#L16)
15+
1216
Injects a signal that tracks the number of mutations that your application is fetching.
1317

1418
Can be used for app-wide loading indicators
@@ -17,7 +21,7 @@ Can be used for app-wide loading indicators
1721

1822
### filters?
1923

20-
`MutationFilters`\<`unknown`, `Error`, `unknown`, `unknown`\>
24+
`MutationFilters`
2125

2226
The filters to apply to the query.
2327

@@ -32,7 +36,3 @@ The Angular injector to use.
3236
`Signal`\<`number`\>
3337

3438
signal with number of fetching mutations.
35-
36-
## Defined in
37-
38-
[inject-is-mutating.ts:16](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-mutating.ts#L16)

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ id: injectMutation
33
title: injectMutation
44
---
55

6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
68
# Function: injectMutation()
79

810
```ts
@@ -12,6 +14,8 @@ function injectMutation<TData, TError, TVariables, TContext>(
1214
): CreateMutationResult<TData, TError, TVariables, TContext>
1315
```
1416

17+
Defined in: [inject-mutation.ts:33](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation.ts#L33)
18+
1519
Injects a mutation: an imperative function that can be invoked which typically performs server side effects.
1620

1721
Unlike queries, mutations are not run automatically.
@@ -45,7 +49,3 @@ The Angular injector to use.
4549
[`CreateMutationResult`](../type-aliases/createmutationresult.md)\<`TData`, `TError`, `TVariables`, `TContext`\>
4650

4751
The mutation.
48-
49-
## Defined in
50-
51-
[inject-mutation.ts:33](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation.ts#L33)

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ id: injectMutationState
33
title: injectMutationState
44
---
55

6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
68
# Function: injectMutationState()
79

810
```ts
@@ -12,11 +14,13 @@ function injectMutationState<TResult>(
1214
): Signal<TResult[]>
1315
```
1416

17+
Defined in: [inject-mutation-state.ts:47](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation-state.ts#L47)
18+
1519
Injects a signal that tracks the state of all mutations.
1620

1721
## Type Parameters
1822

19-
**TResult** = `MutationState`\<`unknown`, `Error`, `unknown`, `unknown`\>
23+
**TResult** = `MutationState`
2024

2125
## Parameters
2226

@@ -37,7 +41,3 @@ The Angular injector to use.
3741
`Signal`\<`TResult`[]\>
3842

3943
The signal that tracks the state of all mutations.
40-
41-
## Defined in
42-
43-
[inject-mutation-state.ts:47](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation-state.ts#L47)

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ id: injectQueries
33
title: injectQueries
44
---
55

6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
68
# Function: injectQueries()
79

810
```ts
@@ -12,11 +14,13 @@ function injectQueries<T, TCombinedResult>(
1214
): Signal<TCombinedResult>
1315
```
1416

17+
Defined in: [inject-queries.ts:198](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-queries.ts#L198)
18+
1519
## Type Parameters
1620

1721
**T** _extends_ `any`[]
1822

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`[]
23+
• **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`[]
2024

2125
## Parameters
2226

@@ -28,7 +32,7 @@ function injectQueries<T, TCombinedResult>(
2832

2933
#### queries
3034

31-
`Signal`\<[`...(T extends [] ? [] : T extends [Head] ? [GetOptions<Head>] : T extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...(...)[]] extends [] ? [] : (...) extends (...) ? (...) : (...) : readonly (...)[] extends [...(...)[]] ? [...(...)[]] : (...) extends (...) ? (...) : (...) : readonly unknown[] extends T ? T : T extends QueryObserverOptionsForCreateQueries<TQueryFnData, TError, TData, TQueryKey>[] ? QueryObserverOptionsForCreateQueries<TQueryFnData, TError, TData, TQueryKey>[] : QueryObserverOptionsForCreateQueries<unknown, Error, unknown, readonly (...)[]>[])[]`]\>
35+
`Signal`\<\[`...(T extends [] ? [] : T extends [Head] ? [GetOptions<Head>] : T extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...(...)[]] extends [] ? [] : (...) extends (...) ? (...) : (...) : readonly (...)[] extends [...(...)[]] ? [...(...)[]] : (...) extends (...) ? (...) : (...) : readonly unknown[] extends T ? T : T extends QueryObserverOptionsForCreateQueries<TQueryFnData, TError, TData, TQueryKey>[] ? QueryObserverOptionsForCreateQueries<TQueryFnData, TError, TData, TQueryKey>[] : QueryObserverOptionsForCreateQueries<unknown, Error, unknown, readonly (...)[]>[])[]`\]\>
3236

3337
### injector?
3438

@@ -37,7 +41,3 @@ function injectQueries<T, TCombinedResult>(
3741
## Returns
3842

3943
`Signal`\<`TCombinedResult`\>
40-
41-
## Defined in
42-
43-
[inject-queries.ts:198](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-queries.ts#L198)

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

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ id: injectQuery
33
title: injectQuery
44
---
55

6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
68
# Function: injectQuery()
79

810
Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
@@ -59,6 +61,8 @@ function injectQuery<TQueryFnData, TError, TData, TQueryKey>(
5961
): DefinedCreateQueryResult<TData, TError>
6062
```
6163

64+
Defined in: [inject-query.ts:53](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L53)
65+
6266
Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
6367

6468
**Basic example**
@@ -140,10 +144,6 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries
140144
141145
https://tanstack.com/query/latest/docs/framework/angular/guides/queries
142146
143-
### Defined in
144-
145-
[inject-query.ts:53](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L53)
146-
147147
## Call Signature
148148
149149
```ts
@@ -153,6 +153,8 @@ function injectQuery<TQueryFnData, TError, TData, TQueryKey>(
153153
): CreateQueryResult<TData, TError>
154154
```
155155

156+
Defined in: [inject-query.ts:105](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L105)
157+
156158
Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
157159

158160
**Basic example**
@@ -234,10 +236,6 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries
234236

235237
https://tanstack.com/query/latest/docs/framework/angular/guides/queries
236238
237-
### Defined in
238-
239-
[inject-query.ts:105](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L105)
240-
241239
## Call Signature
242240

243241
```ts
@@ -247,6 +245,8 @@ function injectQuery<TQueryFnData, TError, TData, TQueryKey>(
247245
): CreateQueryResult<TData, TError>
248246
```
249247

248+
Defined in: [inject-query.ts:157](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L157)
249+
250250
Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
251251

252252
**Basic example**
@@ -327,7 +327,3 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries
327327
### See
328328

329329
https://tanstack.com/query/latest/docs/framework/angular/guides/queries
330-
331-
### Defined in
332-
333-
[inject-query.ts:157](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L157)

0 commit comments

Comments
 (0)