Skip to content

Commit afc6302

Browse files
tannerlinsleytannerlinsley
committed
docs: fix links
commit 113eb6b Author: Tanner Linsley <tannerlinsley@gmail.com> Date: Fri May 23 23:16:11 2025 -0600 docs: fix: only transform generated reference commit d1d084e Author: Tanner Linsley <tannerlinsley@gmail.com> Date: Fri May 23 23:12:07 2025 -0600 docs: fix broken links commit 0df59ea Author: Tanner Linsley <tannerlinsley@gmail.com> Date: Fri May 23 15:54:19 2025 -0600 fix: rewrite type doc links to be directory-relative commit 81e4c71 Author: Tanner Linsley <tannerlinsley@gmail.com> Date: Fri May 23 15:14:51 2025 -0600 fix: initial fix for ./ => ../
1 parent 1b9837f commit afc6302

File tree

151 files changed

+2104
-1439
lines changed

Some content is hidden

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

151 files changed

+2104
-1439
lines changed

‎docs/eslint/eslint-plugin-query.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,9 @@ Alternatively, add `@tanstack/query` to the plugins section, and configure the r
9393

9494
## Rules
9595

96-
- [@tanstack/query/exhaustive-deps](./exhaustive-deps.md)
97-
- [@tanstack/query/no-rest-destructuring](./no-rest-destructuring.md)
98-
- [@tanstack/query/stable-query-client](./stable-query-client.md)
99-
- [@tanstack/query/no-unstable-deps](./no-unstable-deps.md)
100-
- [@tanstack/query/infinite-query-property-order](./infinite-query-property-order.md)
101-
- [@tanstack/query/no-void-query-fn](./no-void-query-fn.md)
96+
- [@tanstack/query/exhaustive-deps](../exhaustive-deps.md)
97+
- [@tanstack/query/no-rest-destructuring](../no-rest-destructuring.md)
98+
- [@tanstack/query/stable-query-client](../stable-query-client.md)
99+
- [@tanstack/query/no-unstable-deps](../no-unstable-deps.md)
100+
- [@tanstack/query/infinite-query-property-order](../infinite-query-property-order.md)
101+
- [@tanstack/query/no-void-query-fn](../no-void-query-fn.md)

‎docs/framework/angular/guides/caching.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: caching
33
title: Caching Examples
44
---
55

6-
> Please thoroughly read the [Important Defaults](./important-defaults.md) before reading this guide
6+
> Please thoroughly read the [Important Defaults](../important-defaults.md) before reading this guide
77
88
## Basic Example
99

@@ -23,11 +23,13 @@ Let's assume we are using the default `gcTime` of **5 minutes** and the default
2323
- A second instance of `injectQuery(() => ({ queryKey: ['todos'], queryFn: fetchTodos })` initializes elsewhere.
2424
- Since the cache already has data for the `['todos']` key from the first query, that data is immediately returned from the cache.
2525
- The new instance triggers a new network request using its query function.
26-
- Note that regardless of whether both `fetchTodos` query functions are identical or not, both queries' [`status`](../../reference/injectQuery.md) are updated (including `isFetching`, `isPending`, and other related values) because they have the same query key.
26+
- Note that regardless of whether both `fetchTodos` query functions are identical or not, both queries' [`status`](../../reference/functions/injectquery.md) are updated (including `isFetching`, `isPending`, and other related values) because they have the same query key.
2727
- When the request completes successfully, the cache's data under the `['todos']` key is updated with the new data, and both instances are updated with the new data.
2828
- Both instances of the `injectQuery(() => ({ queryKey: ['todos'], queryFn: fetchTodos })` query are destroyed and no longer in use.
2929
- Since there are no more active instances of this query, a garbage collection timeout is set using `gcTime` to delete and garbage collect the query (defaults to **5 minutes**).
3030
- Before the cache timeout has completed, another instance of `injectQuery(() => ({ queryKey: ['todos'], queyFn: fetchTodos })` mounts. The query immediately returns the available cached data while the `fetchTodos` function is being run in the background. When it completes successfully, it will populate the cache with fresh data.
3131
- The final instance of `injectQuery(() => ({ queryKey: ['todos'], queryFn: fetchTodos })` gets destroyed.
3232
- No more instances of `injectQuery(() => ({ queryKey: ['todos'], queryFn: fetchTodos })` appear within **5 minutes**.
3333
- The cached data under the `['todos']` key is deleted and garbage collected.
34+
35+
For more advanced use-cases, see [injectQuery](../../reference/functions/injectquery.md).

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

Lines changed: 62 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -13,25 +13,10 @@ 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
19-
function infiniteQueryOptions<
20-
TQueryFnData,
21-
TError,
22-
TData,
23-
TQueryKey,
24-
TPageParam,
25-
>(
26-
options,
27-
): UndefinedInitialDataInfiniteOptions<
28-
TQueryFnData,
29-
TError,
30-
TData,
31-
TQueryKey,
32-
TPageParam
33-
> &
34-
object
19+
function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object
3520
```
3621

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

4732
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
4833

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

5136
• **TPageParam** = `unknown`
5237

5338
### Parameters
5439

55-
• **options**: [`UndefinedInitialDataInfiniteOptions`](../type-aliases/undefinedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
40+
#### options
41+
42+
[`DefinedInitialDataInfiniteOptions`](../../type-aliases/definedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
5643

5744
The infinite query options to tag with the type from `queryFn`.
5845

5946
### Returns
6047

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

6350
The tagged infinite query options.
6451

@@ -70,27 +57,12 @@ The infinite query options to tag with the type from `queryFn`.
7057

7158
### Defined in
7259

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

75-
## infiniteQueryOptions(options)
62+
## Call Signature
7663

7764
```ts
78-
function infiniteQueryOptions<
79-
TQueryFnData,
80-
TError,
81-
TData,
82-
TQueryKey,
83-
TPageParam,
84-
>(
85-
options,
86-
): DefinedInitialDataInfiniteOptions<
87-
TQueryFnData,
88-
TError,
89-
TData,
90-
TQueryKey,
91-
TPageParam
92-
> &
93-
object
65+
function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): UnusedSkipTokenInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object
9466
```
9567

9668
Allows to share and re-use infinite query options in a type-safe way.
@@ -105,19 +77,67 @@ The `queryKey` will be tagged with the type from `queryFn`.
10577

10678
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
10779

108-
• **TQueryKey** _extends_ `QueryKey` = `QueryKey`
80+
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
10981

11082
• **TPageParam** = `unknown`
11183

11284
### Parameters
11385

114-
• **options**: [`DefinedInitialDataInfiniteOptions`](../type-aliases/definedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
86+
#### options
87+
88+
[`UnusedSkipTokenInfiniteOptions`](../../type-aliases/unusedskiptokeninfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
89+
90+
The infinite query options to tag with the type from `queryFn`.
91+
92+
### Returns
93+
94+
[`UnusedSkipTokenInfiniteOptions`](../../type-aliases/unusedskiptokeninfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object`
95+
96+
The tagged infinite query options.
97+
98+
The tagged infinite query options.
99+
100+
### Param
101+
102+
The infinite query options to tag with the type from `queryFn`.
103+
104+
### Defined in
105+
106+
[infinite-query-options.ts:126](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L126)
107+
108+
## Call Signature
109+
110+
```ts
111+
function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object
112+
```
113+
114+
Allows to share and re-use infinite query options in a type-safe way.
115+
116+
The `queryKey` will be tagged with the type from `queryFn`.
117+
118+
### Type Parameters
119+
120+
• **TQueryFnData**
121+
122+
• **TError** = `Error`
123+
124+
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
125+
126+
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
127+
128+
• **TPageParam** = `unknown`
129+
130+
### Parameters
131+
132+
#### options
133+
134+
[`UndefinedInitialDataInfiniteOptions`](../../type-aliases/undefinedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
115135

116136
The infinite query options to tag with the type from `queryFn`.
117137

118138
### Returns
119139

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

122142
The tagged infinite query options.
123143

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

130150
### Defined in
131151

132-
[infinite-query-options.ts:91](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/infinite-query-options.ts#L91)
152+
[infinite-query-options.ts:158](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L158)

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

Lines changed: 40 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,12 @@ A function that returns infinite query options.
1414

1515
## Param
1616

17-
The Angular injector to use.
17+
Additional configuration.
1818

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

2121
```ts
22-
function injectInfiniteQuery<
23-
TQueryFnData,
24-
TError,
25-
TData,
26-
TQueryKey,
27-
TPageParam,
28-
>(optionsFn, injector?): CreateInfiniteQueryResult<TData, TError>
22+
function injectInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(injectInfiniteQueryFn, options?): DefinedCreateInfiniteQueryResult<TData, TError>
2923
```
3024

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

4034
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
4135

42-
• **TQueryKey** _extends_ `QueryKey` = `QueryKey`
36+
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
4337

4438
• **TPageParam** = `unknown`
4539

4640
### Parameters
4741

48-
• **optionsFn**
42+
#### injectInfiniteQueryFn
43+
44+
() => [`DefinedInitialDataInfiniteOptions`](../../type-aliases/definedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
4945

5046
A function that returns infinite query options.
5147

52-
• **injector?**: `Injector`
48+
#### options?
49+
50+
[`InjectInfiniteQueryOptions`](../../interfaces/injectinfinitequeryoptions.md)
5351

54-
The Angular injector to use.
52+
Additional configuration.
5553

5654
### Returns
5755

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

6058
The infinite query result.
6159

@@ -67,22 +65,16 @@ A function that returns infinite query options.
6765

6866
### Param
6967

70-
The Angular injector to use.
68+
Additional configuration.
7169

7270
### Defined in
7371

74-
[inject-infinite-query.ts:30](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-infinite-query.ts#L30)
72+
[inject-infinite-query.ts:42](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L42)
7573

76-
## injectInfiniteQuery(optionsFn, injector)
74+
## Call Signature
7775

7876
```ts
79-
function injectInfiniteQuery<
80-
TQueryFnData,
81-
TError,
82-
TData,
83-
TQueryKey,
84-
TPageParam,
85-
>(optionsFn, injector?): DefinedCreateInfiniteQueryResult<TData, TError>
77+
function injectInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult<TData, TError>
8678
```
8779

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

9789
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
9890

99-
• **TQueryKey** _extends_ `QueryKey` = `QueryKey`
91+
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
10092

10193
• **TPageParam** = `unknown`
10294

10395
### Parameters
10496

105-
• **optionsFn**
97+
#### injectInfiniteQueryFn
98+
99+
() => [`UndefinedInitialDataInfiniteOptions`](../../type-aliases/undefinedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
106100

107101
A function that returns infinite query options.
108102

109-
• **injector?**: `Injector`
103+
#### options?
110104

111-
The Angular injector to use.
105+
[`InjectInfiniteQueryOptions`](../../interfaces/injectinfinitequeryoptions.md)
106+
107+
Additional configuration.
112108

113109
### Returns
114110

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

117113
The infinite query result.
118114

@@ -124,22 +120,16 @@ A function that returns infinite query options.
124120

125121
### Param
126122

127-
The Angular injector to use.
123+
Additional configuration.
128124

129125
### Defined in
130126

131-
[inject-infinite-query.ts:57](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-infinite-query.ts#L57)
127+
[inject-infinite-query.ts:67](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L67)
132128

133-
## injectInfiniteQuery(optionsFn, injector)
129+
## Call Signature
134130

135131
```ts
136-
function injectInfiniteQuery<
137-
TQueryFnData,
138-
TError,
139-
TData,
140-
TQueryKey,
141-
TPageParam,
142-
>(optionsFn, injector?): CreateInfiniteQueryResult<TData, TError>
132+
function injectInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult<TData, TError>
143133
```
144134

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

154144
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
155145

156-
• **TQueryKey** _extends_ `QueryKey` = `QueryKey`
146+
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
157147

158148
• **TPageParam** = `unknown`
159149

160150
### Parameters
161151

162-
• **optionsFn**
152+
#### injectInfiniteQueryFn
153+
154+
() => [`CreateInfiniteQueryOptions`](../../interfaces/createinfinitequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `TPageParam`\>
163155

164156
A function that returns infinite query options.
165157

166-
• **injector?**: `Injector`
158+
#### options?
159+
160+
[`InjectInfiniteQueryOptions`](../../interfaces/injectinfinitequeryoptions.md)
167161

168-
The Angular injector to use.
162+
Additional configuration.
169163

170164
### Returns
171165

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

174168
The infinite query result.
175169

@@ -181,8 +175,8 @@ A function that returns infinite query options.
181175

182176
### Param
183177

184-
The Angular injector to use.
178+
Additional configuration.
185179

186180
### Defined in
187181

188-
[inject-infinite-query.ts:84](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-infinite-query.ts#L84)
182+
[inject-infinite-query.ts:92](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L92)

0 commit comments

Comments
 (0)