Skip to content

Commit 5ad78fc

Browse files
docs: correct local relative links (#9947)
* docs: correct local relative links * Update links * Slight tweaks * String
1 parent 9e8709e commit 5ad78fc

File tree

99 files changed

+414
-449
lines changed

Some content is hidden

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

99 files changed

+414
-449
lines changed

docs/eslint/eslint-plugin-query.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -93,10 +93,10 @@ 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)
102-
- [@tanstack/query/mutation-property-order](../mutation-property-order.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)
102+
- [@tanstack/query/mutation-property-order](./mutation-property-order.md)

docs/framework/angular/guides/caching.md

Lines changed: 3 additions & 3 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,7 +23,7 @@ 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/functions/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**).
@@ -32,4 +32,4 @@ Let's assume we are using the default `gcTime` of **5 minutes** and the default
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.
3434

35-
For more advanced use-cases, see [injectQuery](../../reference/functions/injectQuery.md).
35+
For more advanced use-cases, see [injectQuery](../reference/functions/injectQuery.md).

docs/framework/angular/guides/invalidations-from-mutations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ export class TodosComponent {
3838

3939
[//]: # 'Example2'
4040

41-
You can wire up your invalidations to happen using any of the callbacks available in the [`injectMutation` function](../mutations.md)
41+
You can wire up your invalidations to happen using any of the callbacks available in the [`injectMutation` function](./mutations.md)

docs/framework/angular/guides/mutation-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Mutation Options
55

66
One of the best ways to share mutation options between multiple places,
77
is to use the `mutationOptions` helper. At runtime, this helper just returns whatever you pass into it,
8-
but it has a lot of advantages when using it [with TypeScript](../../typescript#typing-query-options.md).
8+
but it has a lot of advantages when using it [with TypeScript](../typescript#typing-query-options.md).
99
You can define all possible options for a mutation in one place,
1010
and you'll also get type inference and type safety for all of them.
1111

docs/framework/angular/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ or
3131
bun add @tanstack/angular-query-experimental
3232
```
3333

34-
> Wanna give it a spin before you download? Try out the [simple](../examples/simple) or [basic](../examples/basic) examples!
34+
> Wanna give it a spin before you download? Try out the [simple](./examples/simple) or [basic](./examples/basic) examples!

docs/framework/angular/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,4 +109,4 @@ interface Response {
109109

110110
## You talked me into it, so what now?
111111

112-
- Learn TanStack Query at your own pace with our amazingly thorough [Walkthrough Guide](../installation.md) and [API Reference](../reference/functions/injectQuery.md)
112+
- Learn TanStack Query at your own pace with our amazingly thorough [Walkthrough Guide](./installation.md) and [API Reference](./reference/functions/injectQuery.md)

docs/framework/angular/quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: Quick Start
77
88
[//]: # 'Example'
99

10-
If you're looking for a fully functioning example, please have a look at our [basic codesandbox example](../examples/basic)
10+
If you're looking for a fully functioning example, please have a look at our [basic codesandbox example](./examples/basic)
1111

1212
### Provide the client to your App
1313

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

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

5252
#### options
5353

54-
[`DefinedInitialDataInfiniteOptions`](../../type-aliases/DefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
54+
[`DefinedInitialDataInfiniteOptions`](../type-aliases/DefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
5555

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

5858
### Returns
5959

60-
[`CreateInfiniteQueryOptions`](../../interfaces/CreateInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object` & `object`
60+
[`CreateInfiniteQueryOptions`](../interfaces/CreateInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object` & `object`
6161

6262
The tagged infinite query options.
6363

@@ -99,13 +99,13 @@ The `queryKey` will be tagged with the type from `queryFn`.
9999

100100
#### options
101101

102-
[`UnusedSkipTokenInfiniteOptions`](../../type-aliases/UnusedSkipTokenInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
102+
[`UnusedSkipTokenInfiniteOptions`](../type-aliases/UnusedSkipTokenInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
103103

104104
The infinite query options to tag with the type from `queryFn`.
105105

106106
### Returns
107107

108-
`OmitKeyof`\<[`CreateInfiniteQueryOptions`](../../interfaces/CreateInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>, `"queryFn"`\> & `object` & `object`
108+
`OmitKeyof`\<[`CreateInfiniteQueryOptions`](../interfaces/CreateInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>, `"queryFn"`\> & `object` & `object`
109109

110110
The tagged infinite query options.
111111

@@ -147,12 +147,12 @@ The `queryKey` will be tagged with the type from `queryFn`.
147147

148148
#### options
149149

150-
[`UndefinedInitialDataInfiniteOptions`](../../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
150+
[`UndefinedInitialDataInfiniteOptions`](../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
151151

152152
The infinite query options to tag with the type from `queryFn`.
153153

154154
### Returns
155155

156-
[`CreateInfiniteQueryOptions`](../../interfaces/CreateInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object` & `object`
156+
[`CreateInfiniteQueryOptions`](../interfaces/CreateInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object` & `object`
157157

158158
The tagged infinite query options.

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,19 +53,19 @@ Infinite queries can additively "load more" data onto an existing set of data or
5353

5454
#### injectInfiniteQueryFn
5555

56-
() => [`DefinedInitialDataInfiniteOptions`](../../type-aliases/DefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
56+
() => [`DefinedInitialDataInfiniteOptions`](../type-aliases/DefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
5757

5858
A function that returns infinite query options.
5959

6060
#### options?
6161

62-
[`InjectInfiniteQueryOptions`](../../interfaces/InjectInfiniteQueryOptions.md)
62+
[`InjectInfiniteQueryOptions`](../interfaces/InjectInfiniteQueryOptions.md)
6363

6464
Additional configuration.
6565

6666
### Returns
6767

68-
[`DefinedCreateInfiniteQueryResult`](../../type-aliases/DefinedCreateInfiniteQueryResult.md)\<`TData`, `TError`\>
68+
[`DefinedCreateInfiniteQueryResult`](../type-aliases/DefinedCreateInfiniteQueryResult.md)\<`TData`, `TError`\>
6969

7070
The infinite query result.
7171

@@ -106,19 +106,19 @@ Infinite queries can additively "load more" data onto an existing set of data or
106106

107107
#### injectInfiniteQueryFn
108108

109-
() => [`UndefinedInitialDataInfiniteOptions`](../../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
109+
() => [`UndefinedInitialDataInfiniteOptions`](../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
110110

111111
A function that returns infinite query options.
112112

113113
#### options?
114114

115-
[`InjectInfiniteQueryOptions`](../../interfaces/InjectInfiniteQueryOptions.md)
115+
[`InjectInfiniteQueryOptions`](../interfaces/InjectInfiniteQueryOptions.md)
116116

117117
Additional configuration.
118118

119119
### Returns
120120

121-
[`CreateInfiniteQueryResult`](../../type-aliases/CreateInfiniteQueryResult.md)\<`TData`, `TError`\>
121+
[`CreateInfiniteQueryResult`](../type-aliases/CreateInfiniteQueryResult.md)\<`TData`, `TError`\>
122122

123123
The infinite query result.
124124

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

160160
#### injectInfiniteQueryFn
161161

162-
() => [`CreateInfiniteQueryOptions`](../../interfaces/CreateInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
162+
() => [`CreateInfiniteQueryOptions`](../interfaces/CreateInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
163163

164164
A function that returns infinite query options.
165165

166166
#### options?
167167

168-
[`InjectInfiniteQueryOptions`](../../interfaces/InjectInfiniteQueryOptions.md)
168+
[`InjectInfiniteQueryOptions`](../interfaces/InjectInfiniteQueryOptions.md)
169169

170170
Additional configuration.
171171

172172
### Returns
173173

174-
[`CreateInfiniteQueryResult`](../../type-aliases/CreateInfiniteQueryResult.md)\<`TData`, `TError`\>
174+
[`CreateInfiniteQueryResult`](../type-aliases/CreateInfiniteQueryResult.md)\<`TData`, `TError`\>
175175

176176
The infinite query result.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The filters to apply to the query.
2626

2727
### options?
2828

29-
[`InjectIsFetchingOptions`](../../interfaces/InjectIsFetchingOptions.md)
29+
[`InjectIsFetchingOptions`](../interfaces/InjectIsFetchingOptions.md)
3030

3131
Additional configuration
3232

0 commit comments

Comments
 (0)