Skip to content

Commit a16dc55

Browse files
docs: re-generate typedoc
1 parent f04dd19 commit a16dc55

File tree

77 files changed

+1179
-380
lines changed

Some content is hidden

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

77 files changed

+1179
-380
lines changed

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

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The `queryKey` will be tagged with the type from `queryFn`.
1313

1414
The infinite query options to tag with the type from `queryFn`.
1515

16-
## infiniteQueryOptions(options)
16+
## Call Signature
1717

1818
```ts
1919
function infiniteQueryOptions<
@@ -24,7 +24,7 @@ function infiniteQueryOptions<
2424
TPageParam,
2525
>(
2626
options,
27-
): UndefinedInitialDataInfiniteOptions<
27+
): DefinedInitialDataInfiniteOptions<
2828
TQueryFnData,
2929
TError,
3030
TData,
@@ -46,19 +46,21 @@ The `queryKey` will be tagged with the type from `queryFn`.
4646

4747
**TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
4848

49-
**TQueryKey** _extends_ `QueryKey` = `QueryKey`
49+
**TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
5050

5151
**TPageParam** = `unknown`
5252

5353
### Parameters
5454

55-
**options**: [`UndefinedInitialDataInfiniteOptions`](../type-aliases/undefinedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
55+
#### options
56+
57+
[`DefinedInitialDataInfiniteOptions`](../type-aliases/definedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
5658

5759
The infinite query options to tag with the type from `queryFn`.
5860

5961
### Returns
6062

61-
[`UndefinedInitialDataInfiniteOptions`](../type-aliases/undefinedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object`
63+
[`DefinedInitialDataInfiniteOptions`](../type-aliases/definedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object`
6264

6365
The tagged infinite query options.
6466

@@ -70,9 +72,9 @@ The infinite query options to tag with the type from `queryFn`.
7072

7173
### Defined in
7274

73-
[infinite-query-options.ts:59](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/infinite-query-options.ts#L59)
75+
[infinite-query-options.ts:59](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L59)
7476

75-
## infiniteQueryOptions(options)
77+
## Call Signature
7678

7779
```ts
7880
function infiniteQueryOptions<
@@ -83,7 +85,7 @@ function infiniteQueryOptions<
8385
TPageParam,
8486
>(
8587
options,
86-
): DefinedInitialDataInfiniteOptions<
88+
): UndefinedInitialDataInfiniteOptions<
8789
TQueryFnData,
8890
TError,
8991
TData,
@@ -105,19 +107,21 @@ The `queryKey` will be tagged with the type from `queryFn`.
105107

106108
**TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
107109

108-
**TQueryKey** _extends_ `QueryKey` = `QueryKey`
110+
**TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
109111

110112
**TPageParam** = `unknown`
111113

112114
### Parameters
113115

114-
**options**: [`DefinedInitialDataInfiniteOptions`](../type-aliases/definedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
116+
#### options
117+
118+
[`UndefinedInitialDataInfiniteOptions`](../type-aliases/undefinedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
115119

116120
The infinite query options to tag with the type from `queryFn`.
117121

118122
### Returns
119123

120-
[`DefinedInitialDataInfiniteOptions`](../type-aliases/definedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object`
124+
[`UndefinedInitialDataInfiniteOptions`](../type-aliases/undefinedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object`
121125

122126
The tagged infinite query options.
123127

@@ -129,4 +133,4 @@ The infinite query options to tag with the type from `queryFn`.
129133

130134
### Defined in
131135

132-
[infinite-query-options.ts:91](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/infinite-query-options.ts#L91)
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: 31 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ A function that returns infinite query options.
1616

1717
The Angular injector to use.
1818

19-
## injectInfiniteQuery(optionsFn, injector)
19+
## Call Signature
2020

2121
```ts
2222
function injectInfiniteQuery<
@@ -25,7 +25,7 @@ function injectInfiniteQuery<
2525
TData,
2626
TQueryKey,
2727
TPageParam,
28-
>(optionsFn, injector?): CreateInfiniteQueryResult<TData, TError>
28+
>(optionsFn, injector?): DefinedCreateInfiniteQueryResult<TData, TError>
2929
```
3030

3131
Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
@@ -39,23 +39,27 @@ Infinite queries can additively "load more" data onto an existing set of data or
3939

4040
**TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
4141

42-
**TQueryKey** _extends_ `QueryKey` = `QueryKey`
42+
**TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
4343

4444
**TPageParam** = `unknown`
4545

4646
### Parameters
4747

48-
**optionsFn**
48+
#### optionsFn
49+
50+
() => [`DefinedInitialDataInfiniteOptions`](../type-aliases/definedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
4951

5052
A function that returns infinite query options.
5153

52-
**injector?**: `Injector`
54+
#### injector?
55+
56+
`Injector`
5357

5458
The Angular injector to use.
5559

5660
### Returns
5761

58-
[`CreateInfiniteQueryResult`](../type-aliases/createinfinitequeryresult.md)\<`TData`, `TError`\>
62+
[`DefinedCreateInfiniteQueryResult`](../type-aliases/definedcreateinfinitequeryresult.md)\<`TData`, `TError`\>
5963

6064
The infinite query result.
6165

@@ -71,9 +75,9 @@ The Angular injector to use.
7175

7276
### Defined in
7377

74-
[inject-infinite-query.ts:30](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-infinite-query.ts#L30)
78+
[inject-infinite-query.ts:29](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L29)
7579

76-
## injectInfiniteQuery(optionsFn, injector)
80+
## Call Signature
7781

7882
```ts
7983
function injectInfiniteQuery<
@@ -82,7 +86,7 @@ function injectInfiniteQuery<
8286
TData,
8387
TQueryKey,
8488
TPageParam,
85-
>(optionsFn, injector?): DefinedCreateInfiniteQueryResult<TData, TError>
89+
>(optionsFn, injector?): CreateInfiniteQueryResult<TData, TError>
8690
```
8791

8892
Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
@@ -96,23 +100,27 @@ Infinite queries can additively "load more" data onto an existing set of data or
96100

97101
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
98102

99-
**TQueryKey** _extends_ `QueryKey` = `QueryKey`
103+
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
100104

101105
• **TPageParam** = `unknown`
102106

103107
### Parameters
104108

105-
**optionsFn**
109+
#### optionsFn
110+
111+
() => [`UndefinedInitialDataInfiniteOptions`](../type-aliases/undefinedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
106112

107113
A function that returns infinite query options.
108114

109-
**injector?**: `Injector`
115+
#### injector?
116+
117+
`Injector`
110118

111119
The Angular injector to use.
112120

113121
### Returns
114122

115-
[`DefinedCreateInfiniteQueryResult`](../type-aliases/definedcreateinfinitequeryresult.md)\<`TData`, `TError`\>
123+
[`CreateInfiniteQueryResult`](../type-aliases/createinfinitequeryresult.md)\<`TData`, `TError`\>
116124

117125
The infinite query result.
118126

@@ -128,9 +136,9 @@ The Angular injector to use.
128136

129137
### Defined in
130138

131-
[inject-infinite-query.ts:57](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-infinite-query.ts#L57)
139+
[inject-infinite-query.ts:54](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L54)
132140

133-
## injectInfiniteQuery(optionsFn, injector)
141+
## Call Signature
134142

135143
```ts
136144
function injectInfiniteQuery<
@@ -153,17 +161,21 @@ Infinite queries can additively "load more" data onto an existing set of data or
153161

154162
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
155163

156-
• **TQueryKey** _extends_ `QueryKey` = `QueryKey`
164+
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
157165

158166
• **TPageParam** = `unknown`
159167

160168
### Parameters
161169

162-
• **optionsFn**
170+
#### optionsFn
171+
172+
() => [`CreateInfiniteQueryOptions`](../interfaces/createinfinitequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `TPageParam`\>
163173

164174
A function that returns infinite query options.
165175

166-
• **injector?**: `Injector`
176+
#### injector?
177+
178+
`Injector`
167179

168180
The Angular injector to use.
169181

@@ -185,4 +197,4 @@ The Angular injector to use.
185197

186198
### Defined in
187199

188-
[inject-infinite-query.ts:84](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-infinite-query.ts#L84)
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: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,15 @@ Can be used for app-wide loading indicators
1616

1717
## Parameters
1818

19-
**filters?**: `QueryFilters`
19+
### filters?
20+
21+
`QueryFilters`\<`unknown`, `Error`, `unknown`, readonly `unknown`[]\>
2022

2123
The filters to apply to the query.
2224

23-
**injector?**: `Injector`
25+
### injector?
26+
27+
`Injector`
2428

2529
The Angular injector to use.
2630

@@ -32,4 +36,4 @@ signal with number of loading or fetching queries.
3236

3337
## Defined in
3438

35-
[inject-is-fetching.ts:17](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-is-fetching.ts#L17)
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: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,15 @@ Can be used for app-wide loading indicators
1515

1616
## Parameters
1717

18-
**filters?**: `MutationFilters`
18+
### filters?
19+
20+
`MutationFilters`\<`unknown`, `Error`, `unknown`, `unknown`\>
1921

2022
The filters to apply to the query.
2123

22-
**injector?**: `Injector`
24+
### injector?
25+
26+
`Injector`
2327

2428
The Angular injector to use.
2529

@@ -31,4 +35,4 @@ signal with number of fetching mutations.
3135

3236
## Defined in
3337

34-
[inject-is-mutating.ts:16](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-is-mutating.ts#L16)
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: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,15 @@ Unlike queries, mutations are not run automatically.
2828

2929
## Parameters
3030

31-
**optionsFn**
31+
### optionsFn
32+
33+
() => [`CreateMutationOptions`](../interfaces/createmutationoptions.md)\<`TData`, `TError`, `TVariables`, `TContext`\>
3234

3335
A function that returns mutation options.
3436

35-
**injector?**: `Injector`
37+
### injector?
38+
39+
`Injector`
3640

3741
The Angular injector to use.
3842

@@ -44,4 +48,4 @@ The mutation.
4448

4549
## Defined in
4650

47-
[inject-mutation.ts:38](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-mutation.ts#L38)
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: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,15 @@ Injects a signal that tracks the state of all mutations.
2020

2121
## Parameters
2222

23-
**mutationStateOptionsFn** = `...`
23+
### mutationStateOptionsFn
24+
25+
() => `MutationStateOptions`\<`TResult`\>
2426

2527
A function that returns mutation state options.
2628

27-
**options?**: [`InjectMutationStateOptions`](../interfaces/injectmutationstateoptions.md)
29+
### options?
30+
31+
[`InjectMutationStateOptions`](../interfaces/injectmutationstateoptions.md)
2832

2933
The Angular injector to use.
3034

@@ -36,4 +40,4 @@ The signal that tracks the state of all mutations.
3640

3741
## Defined in
3842

39-
[inject-mutation-state.ts:53](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-mutation-state.ts#L53)
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: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,24 @@ function injectQueries<T, TCombinedResult>(
2020

2121
## Parameters
2222

23-
**\_\_namedParameters**
23+
### \_\_namedParameters
2424

25-
**\_\_namedParameters.combine?**
25+
#### combine
2626

27-
**\_\_namedParameters.queries?**: `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, QueryKey>[])[]`]\>
27+
(`result`) => `TCombinedResult`
2828

29-
**injector?**: `Injector`
29+
#### queries
30+
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 (...)[]>[])[]`]\>
32+
33+
### injector?
34+
35+
`Injector`
3036

3137
## Returns
3238

3339
`Signal`\<`TCombinedResult`\>
3440

3541
## Defined in
3642

37-
[inject-queries.ts:188](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-queries.ts#L188)
43+
[inject-queries.ts:198](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-queries.ts#L198)

0 commit comments

Comments
 (0)