Skip to content

Commit 0b2c9d7

Browse files
lachlancollinslachlancollins
committed
docs(typedoc): use sub-folders for reference docs
1 parent dac5da5 commit 0b2c9d7

File tree

80 files changed

+491
-354
lines changed

Some content is hidden

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

80 files changed

+491
-354
lines changed

‎docs/config.json

+10-2
Original file line numberDiff line numberDiff line change
@@ -747,11 +747,11 @@
747747
},
748748
{
749749
"label": "Functions / createQuery",
750-
"to": "framework/svelte/reference/createQuery"
750+
"to": "framework/svelte/reference/functions/createquery"
751751
},
752752
{
753753
"label": "Functions / createMutation",
754-
"to": "framework/svelte/reference/createMutation"
754+
"to": "framework/svelte/reference/functions/createmutation"
755755
}
756756
]
757757
},
@@ -761,6 +761,14 @@
761761
{
762762
"label": "Angular Reference",
763763
"to": "framework/angular/reference/index"
764+
},
765+
{
766+
"label": "Functions / injectQuery",
767+
"to": "framework/angular/reference/functions/injectquery"
768+
},
769+
{
770+
"label": "Functions / injectMutation",
771+
"to": "framework/angular/reference/functions/injectmutation"
764772
}
765773
]
766774
}

‎docs/framework/angular/reference/infiniteQueryOptions.md renamed to ‎docs/framework/angular/reference/functions/infinitequeryoptions.md

+18-6
Original file line numberDiff line numberDiff line change
@@ -52,19 +52,25 @@ The `queryKey` will be tagged with the type from `queryFn`.
5252

5353
### Parameters
5454

55-
• **options**: [`UndefinedInitialDataInfiniteOptions`](UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
55+
• **options**: [`UndefinedInitialDataInfiniteOptions`](../type-aliases/undefinedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
5656

5757
The infinite query options to tag with the type from `queryFn`.
5858

5959
### Returns
6060

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

6363
The tagged infinite query options.
6464

65+
The tagged infinite query options.
66+
67+
### Param
68+
69+
The infinite query options to tag with the type from `queryFn`.
70+
6571
### Defined in
6672

67-
[infinite-query-options.ts:59](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/infinite-query-options.ts#L59)
73+
[infinite-query-options.ts:59](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/infinite-query-options.ts#L59)
6874

6975
## infiniteQueryOptions(options)
7076

@@ -105,16 +111,22 @@ The `queryKey` will be tagged with the type from `queryFn`.
105111

106112
### Parameters
107113

108-
• **options**: [`DefinedInitialDataInfiniteOptions`](DefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
114+
• **options**: [`DefinedInitialDataInfiniteOptions`](../type-aliases/definedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
109115

110116
The infinite query options to tag with the type from `queryFn`.
111117

112118
### Returns
113119

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

116122
The tagged infinite query options.
117123

124+
The tagged infinite query options.
125+
126+
### Param
127+
128+
The infinite query options to tag with the type from `queryFn`.
129+
118130
### Defined in
119131

120-
[infinite-query-options.ts:91](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/infinite-query-options.ts#L91)
132+
[infinite-query-options.ts:91](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/infinite-query-options.ts#L91)

‎docs/framework/angular/reference/injectInfiniteQuery.md renamed to ‎docs/framework/angular/reference/functions/injectinfinitequery.md

+36-6
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,23 @@ The Angular injector to use.
5555

5656
### Returns
5757

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

6060
The infinite query result.
6161

62+
The infinite query result.
63+
64+
### Param
65+
66+
A function that returns infinite query options.
67+
68+
### Param
69+
70+
The Angular injector to use.
71+
6272
### Defined in
6373

64-
[inject-infinite-query.ts:30](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-infinite-query.ts#L30)
74+
[inject-infinite-query.ts:30](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-infinite-query.ts#L30)
6575

6676
## injectInfiniteQuery(optionsFn, injector)
6777

@@ -102,13 +112,23 @@ The Angular injector to use.
102112

103113
### Returns
104114

105-
[`DefinedCreateInfiniteQueryResult`](DefinedCreateInfiniteQueryResult.md)\<`TData`, `TError`\>
115+
[`DefinedCreateInfiniteQueryResult`](../type-aliases/definedcreateinfinitequeryresult.md)\<`TData`, `TError`\>
116+
117+
The infinite query result.
106118

107119
The infinite query result.
108120

121+
### Param
122+
123+
A function that returns infinite query options.
124+
125+
### Param
126+
127+
The Angular injector to use.
128+
109129
### Defined in
110130

111-
[inject-infinite-query.ts:57](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-infinite-query.ts#L57)
131+
[inject-infinite-query.ts:57](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-infinite-query.ts#L57)
112132

113133
## injectInfiniteQuery(optionsFn, injector)
114134

@@ -149,10 +169,20 @@ The Angular injector to use.
149169

150170
### Returns
151171

152-
[`CreateInfiniteQueryResult`](CreateInfiniteQueryResult.md)\<`TData`, `TError`\>
172+
[`CreateInfiniteQueryResult`](../type-aliases/createinfinitequeryresult.md)\<`TData`, `TError`\>
173+
174+
The infinite query result.
153175

154176
The infinite query result.
155177

178+
### Param
179+
180+
A function that returns infinite query options.
181+
182+
### Param
183+
184+
The Angular injector to use.
185+
156186
### Defined in
157187

158-
[inject-infinite-query.ts:84](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-infinite-query.ts#L84)
188+
[inject-infinite-query.ts:84](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-infinite-query.ts#L84)

‎docs/framework/angular/reference/injectIsFetching.md renamed to ‎docs/framework/angular/reference/functions/injectisfetching.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@ signal with number of loading or fetching queries.
3232

3333
## Defined in
3434

35-
[inject-is-fetching.ts:17](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-is-fetching.ts#L17)
35+
[inject-is-fetching.ts:17](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-is-fetching.ts#L17)

‎docs/framework/angular/reference/injectIsMutating.md renamed to ‎docs/framework/angular/reference/functions/injectismutating.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ signal with number of fetching mutations.
3131

3232
## Defined in
3333

34-
[inject-is-mutating.ts:16](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-is-mutating.ts#L16)
34+
[inject-is-mutating.ts:16](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-is-mutating.ts#L16)

‎docs/framework/angular/reference/injectMutation.md renamed to ‎docs/framework/angular/reference/functions/injectmutation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ The Angular injector to use.
3838

3939
## Returns
4040

41-
[`CreateMutationResult`](CreateMutationResult.md)\<`TData`, `TError`, `TVariables`, `TContext`\>
41+
[`CreateMutationResult`](../type-aliases/createmutationresult.md)\<`TData`, `TError`, `TVariables`, `TContext`\>
4242

4343
The mutation.
4444

4545
## Defined in
4646

47-
[inject-mutation.ts:38](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-mutation.ts#L38)
47+
[inject-mutation.ts:38](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-mutation.ts#L38)

‎docs/framework/angular/reference/injectMutationState.md renamed to ‎docs/framework/angular/reference/functions/injectmutationstate.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Injects a signal that tracks the state of all mutations.
2424

2525
A function that returns mutation state options.
2626

27-
• **options?**: [`InjectMutationStateOptions`](InjectMutationStateOptions.md)
27+
• **options?**: [`InjectMutationStateOptions`](../interfaces/injectmutationstateoptions.md)
2828

2929
The Angular injector to use.
3030

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

3737
## Defined in
3838

39-
[inject-mutation-state.ts:53](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-mutation-state.ts#L53)
39+
[inject-mutation-state.ts:53](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-mutation-state.ts#L53)

‎docs/framework/angular/reference/injectQueries.md renamed to ‎docs/framework/angular/reference/functions/injectqueries.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,4 @@ function injectQueries<T, TCombinedResult>(
3434

3535
## Defined in
3636

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

‎docs/framework/angular/reference/injectQuery.md renamed to ‎docs/framework/angular/reference/functions/injectquery.md

+48-6
Original file line numberDiff line numberDiff line change
@@ -114,17 +114,31 @@ The Angular injector to use.
114114

115115
### Returns
116116

117-
[`DefinedCreateQueryResult`](DefinedCreateQueryResult.md)\<`TData`, `TError`\>
117+
[`DefinedCreateQueryResult`](../type-aliases/definedcreatequeryresult.md)\<`TData`, `TError`\>
118118

119119
The query result.
120120

121+
The query result.
122+
123+
### Param
124+
125+
A function that returns query options.
126+
127+
### Param
128+
129+
The Angular injector to use.
130+
131+
### See
132+
133+
https://tanstack.com/query/latest/docs/framework/angular/guides/queries
134+
121135
### See
122136

123137
https://tanstack.com/query/latest/docs/framework/angular/guides/queries
124138

125139
### Defined in
126140

127-
[inject-query.ts:53](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-query.ts#L53)
141+
[inject-query.ts:53](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-query.ts#L53)
128142

129143
## injectQuery(optionsFn, injector)
130144

@@ -190,17 +204,31 @@ The Angular injector to use.
190204
191205
### Returns
192206
193-
[`CreateQueryResult`](CreateQueryResult.md)\<`TData`, `TError`\>
207+
[`CreateQueryResult`](../type-aliases/createqueryresult.md)\<`TData`, `TError`\>
208+
209+
The query result.
194210
195211
The query result.
196212
213+
### Param
214+
215+
A function that returns query options.
216+
217+
### Param
218+
219+
The Angular injector to use.
220+
221+
### See
222+
223+
https://tanstack.com/query/latest/docs/framework/angular/guides/queries
224+
197225
### See
198226
199227
https://tanstack.com/query/latest/docs/framework/angular/guides/queries
200228
201229
### Defined in
202230
203-
[inject-query.ts:102](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-query.ts#L102)
231+
[inject-query.ts:102](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-query.ts#L102)
204232
205233
## injectQuery(optionsFn, injector)
206234
@@ -266,14 +294,28 @@ The Angular injector to use.
266294
267295
### Returns
268296
269-
[`CreateQueryResult`](CreateQueryResult.md)\<`TData`, `TError`\>
297+
[`CreateQueryResult`](../type-aliases/createqueryresult.md)\<`TData`, `TError`\>
298+
299+
The query result.
270300
271301
The query result.
272302
303+
### Param
304+
305+
A function that returns query options.
306+
307+
### Param
308+
309+
The Angular injector to use.
310+
311+
### See
312+
313+
https://tanstack.com/query/latest/docs/framework/angular/guides/queries
314+
273315
### See
274316
275317
https://tanstack.com/query/latest/docs/framework/angular/guides/queries
276318
277319
### Defined in
278320
279-
[inject-query.ts:151](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-query.ts#L151)
321+
[inject-query.ts:151](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-query.ts#L151)

‎docs/framework/angular/reference/injectQueryClient.md renamed to ‎docs/framework/angular/reference/functions/injectqueryclient.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ const queryClient = injectQueryClient()
3333

3434
### Defined in
3535

36-
[inject-query-client.ts:16](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-query-client.ts#L16)
36+
[inject-query-client.ts:16](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-query-client.ts#L16)
3737

3838
## injectQueryClient(injectOptions)
3939

@@ -59,7 +59,7 @@ const queryClient = injectQueryClient()
5959

6060
### Defined in
6161

62-
[inject-query-client.ts:16](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-query-client.ts#L16)
62+
[inject-query-client.ts:16](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-query-client.ts#L16)
6363

6464
## injectQueryClient(injectOptions)
6565

@@ -85,4 +85,4 @@ const queryClient = injectQueryClient()
8585

8686
### Defined in
8787

88-
[inject-query-client.ts:16](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-query-client.ts#L16)
88+
[inject-query-client.ts:16](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-query-client.ts#L16)

‎docs/framework/angular/reference/provideAngularQuery.md renamed to ‎docs/framework/angular/reference/functions/provideangularquery.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,4 @@ https://tanstack.com/query/v5/docs/framework/angular/quick-start
6161

6262
## Defined in
6363

64-
[providers.ts:50](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/providers.ts#L50)
64+
[providers.ts:50](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/providers.ts#L50)

‎docs/framework/angular/reference/provideQueryClient.md renamed to ‎docs/framework/angular/reference/functions/providequeryclient.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: provideQueryClient
99
function provideQueryClient(value): Provider
1010
```
1111

12-
Usually [provideAngularQuery](provideAngularQuery.md) is used once to set up TanStack Query and the
12+
Usually [provideAngularQuery](provideangularquery.md) is used once to set up TanStack Query and the
1313
[https://tanstack.com/query/latest/docs/reference/QueryClient|QueryClient](https://tanstack.com/query/latest/docs/reference/QueryClient|QueryClient)
1414
for the entire application. You can use `provideQueryClient` to provide a
1515
different `QueryClient` instance for a part of the application.
@@ -24,4 +24,4 @@ different `QueryClient` instance for a part of the application.
2424

2525
## Defined in
2626

27-
[inject-query-client.ts:25](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-query-client.ts#L25)
27+
[inject-query-client.ts:25](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-query-client.ts#L25)

0 commit comments

Comments
 (0)