Skip to content

Commit 81fcb35

Browse files
Slight tweaks
1 parent a024b9f commit 81fcb35

9 files changed

Lines changed: 94 additions & 104 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ function injectIsRestoring(options?): Signal<boolean>;
1111

1212
Defined in: [inject-is-restoring.ts:32](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-restoring.ts#L32)
1313

14-
Injects a signal that tracks whether a restore is currently in progress. [injectQuery](./injectQuery.md) and friends also check this internally to avoid race conditions between the restore and initializing queries.
14+
Injects a signal that tracks whether a restore is currently in progress. [injectQuery](injectQuery.md) and friends also check this internally to avoid race conditions between the restore and initializing queries.
1515

1616
## Parameters
1717

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ function provideQueryClient(queryClient): Provider;
1111

1212
Defined in: [providers.ts:14](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L14)
1313

14-
Usually [provideTanStackQuery](./provideTanStackQuery.md) is used once to set up TanStack Query and the
14+
Usually [provideTanStackQuery](provideTanStackQuery.md) is used once to set up TanStack Query and the
1515
[https://tanstack.com/query/latest/docs/reference/QueryClient\|QueryClient](https://tanstack.com/query/latest/docs/reference/QueryClient|QueryClient)
1616
for the entire application. Internally it calls `provideQueryClient`.
1717
You can use `provideQueryClient` to provide a different `QueryClient` instance for a part

docs/framework/angular/reference/index.md

Lines changed: 49 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -7,58 +7,58 @@ title: "@tanstack/angular-query-experimental"
77

88
## Interfaces
99

10-
- [BaseMutationNarrowing](./interfaces/BaseMutationNarrowing.md)
11-
- [BaseQueryNarrowing](./interfaces/BaseQueryNarrowing.md)
12-
- [CreateBaseQueryOptions](./interfaces/CreateBaseQueryOptions.md)
13-
- [CreateInfiniteQueryOptions](./interfaces/CreateInfiniteQueryOptions.md)
14-
- [CreateMutationOptions](./interfaces/CreateMutationOptions.md)
15-
- [CreateQueryOptions](./interfaces/CreateQueryOptions.md)
16-
- [InjectInfiniteQueryOptions](./interfaces/InjectInfiniteQueryOptions.md)
17-
- [InjectIsFetchingOptions](./interfaces/InjectIsFetchingOptions.md)
18-
- [InjectIsMutatingOptions](./interfaces/InjectIsMutatingOptions.md)
19-
- [InjectMutationOptions](./interfaces/InjectMutationOptions.md)
20-
- [InjectMutationStateOptions](./interfaces/InjectMutationStateOptions.md)
21-
- [InjectQueryOptions](./interfaces/InjectQueryOptions.md)
22-
- [QueryFeature](./interfaces/QueryFeature.md)
10+
- [BaseMutationNarrowing](interfaces/BaseMutationNarrowing.md)
11+
- [BaseQueryNarrowing](interfaces/BaseQueryNarrowing.md)
12+
- [CreateBaseQueryOptions](interfaces/CreateBaseQueryOptions.md)
13+
- [CreateInfiniteQueryOptions](interfaces/CreateInfiniteQueryOptions.md)
14+
- [CreateMutationOptions](interfaces/CreateMutationOptions.md)
15+
- [CreateQueryOptions](interfaces/CreateQueryOptions.md)
16+
- [InjectInfiniteQueryOptions](interfaces/InjectInfiniteQueryOptions.md)
17+
- [InjectIsFetchingOptions](interfaces/InjectIsFetchingOptions.md)
18+
- [InjectIsMutatingOptions](interfaces/InjectIsMutatingOptions.md)
19+
- [InjectMutationOptions](interfaces/InjectMutationOptions.md)
20+
- [InjectMutationStateOptions](interfaces/InjectMutationStateOptions.md)
21+
- [InjectQueryOptions](interfaces/InjectQueryOptions.md)
22+
- [QueryFeature](interfaces/QueryFeature.md)
2323

2424
## Type Aliases
2525

26-
- [CreateBaseMutationResult](./type-aliases/CreateBaseMutationResult.md)
27-
- [CreateBaseQueryResult](./type-aliases/CreateBaseQueryResult.md)
28-
- [CreateInfiniteQueryResult](./type-aliases/CreateInfiniteQueryResult.md)
29-
- [CreateMutateAsyncFunction](./type-aliases/CreateMutateAsyncFunction.md)
30-
- [CreateMutateFunction](./type-aliases/CreateMutateFunction.md)
31-
- [CreateMutationResult](./type-aliases/CreateMutationResult.md)
32-
- [CreateQueryResult](./type-aliases/CreateQueryResult.md)
33-
- [DefinedCreateInfiniteQueryResult](./type-aliases/DefinedCreateInfiniteQueryResult.md)
34-
- [DefinedCreateQueryResult](./type-aliases/DefinedCreateQueryResult.md)
35-
- [DefinedInitialDataInfiniteOptions](./type-aliases/DefinedInitialDataInfiniteOptions.md)
36-
- [DefinedInitialDataOptions](./type-aliases/DefinedInitialDataOptions.md)
37-
- [DevtoolsFeature](./type-aliases/DevtoolsFeature.md)
38-
- [PersistQueryClientFeature](./type-aliases/PersistQueryClientFeature.md)
39-
- [QueriesOptions](./type-aliases/QueriesOptions.md)
40-
- [QueriesResults](./type-aliases/QueriesResults.md)
41-
- [QueryFeatures](./type-aliases/QueryFeatures.md)
42-
- [UndefinedInitialDataInfiniteOptions](./type-aliases/UndefinedInitialDataInfiniteOptions.md)
43-
- [UndefinedInitialDataOptions](./type-aliases/UndefinedInitialDataOptions.md)
44-
- [UnusedSkipTokenInfiniteOptions](./type-aliases/UnusedSkipTokenInfiniteOptions.md)
45-
- [UnusedSkipTokenOptions](./type-aliases/UnusedSkipTokenOptions.md)
26+
- [CreateBaseMutationResult](type-aliases/CreateBaseMutationResult.md)
27+
- [CreateBaseQueryResult](type-aliases/CreateBaseQueryResult.md)
28+
- [CreateInfiniteQueryResult](type-aliases/CreateInfiniteQueryResult.md)
29+
- [CreateMutateAsyncFunction](type-aliases/CreateMutateAsyncFunction.md)
30+
- [CreateMutateFunction](type-aliases/CreateMutateFunction.md)
31+
- [CreateMutationResult](type-aliases/CreateMutationResult.md)
32+
- [CreateQueryResult](type-aliases/CreateQueryResult.md)
33+
- [DefinedCreateInfiniteQueryResult](type-aliases/DefinedCreateInfiniteQueryResult.md)
34+
- [DefinedCreateQueryResult](type-aliases/DefinedCreateQueryResult.md)
35+
- [DefinedInitialDataInfiniteOptions](type-aliases/DefinedInitialDataInfiniteOptions.md)
36+
- [DefinedInitialDataOptions](type-aliases/DefinedInitialDataOptions.md)
37+
- [DevtoolsFeature](type-aliases/DevtoolsFeature.md)
38+
- [PersistQueryClientFeature](type-aliases/PersistQueryClientFeature.md)
39+
- [QueriesOptions](type-aliases/QueriesOptions.md)
40+
- [QueriesResults](type-aliases/QueriesResults.md)
41+
- [QueryFeatures](type-aliases/QueryFeatures.md)
42+
- [UndefinedInitialDataInfiniteOptions](type-aliases/UndefinedInitialDataInfiniteOptions.md)
43+
- [UndefinedInitialDataOptions](type-aliases/UndefinedInitialDataOptions.md)
44+
- [UnusedSkipTokenInfiniteOptions](type-aliases/UnusedSkipTokenInfiniteOptions.md)
45+
- [UnusedSkipTokenOptions](type-aliases/UnusedSkipTokenOptions.md)
4646

4747
## Functions
4848

49-
- [infiniteQueryOptions](./functions/infiniteQueryOptions.md)
50-
- [injectInfiniteQuery](./functions/injectInfiniteQuery.md)
51-
- [injectIsFetching](./functions/injectIsFetching.md)
52-
- [injectIsMutating](./functions/injectIsMutating.md)
53-
- [injectIsRestoring](./functions/injectIsRestoring.md)
54-
- [injectMutation](./functions/injectMutation.md)
55-
- [injectMutationState](./functions/injectMutationState.md)
56-
- [injectQuery](./functions/injectQuery.md)
57-
- [~~injectQueryClient~~](./functions/injectQueryClient.md)
58-
- [mutationOptions](./functions/mutationOptions.md)
59-
- [~~provideAngularQuery~~](./functions/provideAngularQuery.md)
60-
- [provideIsRestoring](./functions/provideIsRestoring.md)
61-
- [provideQueryClient](./functions/provideQueryClient.md)
62-
- [provideTanStackQuery](./functions/provideTanStackQuery.md)
63-
- [queryFeature](./functions/queryFeature.md)
64-
- [queryOptions](./functions/queryOptions.md)
49+
- [infiniteQueryOptions](functions/infiniteQueryOptions.md)
50+
- [injectInfiniteQuery](functions/injectInfiniteQuery.md)
51+
- [injectIsFetching](functions/injectIsFetching.md)
52+
- [injectIsMutating](functions/injectIsMutating.md)
53+
- [injectIsRestoring](functions/injectIsRestoring.md)
54+
- [injectMutation](functions/injectMutation.md)
55+
- [injectMutationState](functions/injectMutationState.md)
56+
- [injectQuery](functions/injectQuery.md)
57+
- [~~injectQueryClient~~](functions/injectQueryClient.md)
58+
- [mutationOptions](functions/mutationOptions.md)
59+
- [~~provideAngularQuery~~](functions/provideAngularQuery.md)
60+
- [provideIsRestoring](functions/provideIsRestoring.md)
61+
- [provideQueryClient](functions/provideQueryClient.md)
62+
- [provideTanStackQuery](functions/provideTanStackQuery.md)
63+
- [queryFeature](functions/queryFeature.md)
64+
- [queryOptions](functions/queryOptions.md)

docs/framework/angular/reference/interfaces/CreateQueryOptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Defined in: [types.ts:35](https://github.com/TanStack/query/blob/main/packages/a
99

1010
## Extends
1111

12-
- `OmitKeyof`\<[`CreateBaseQueryOptions`](./CreateBaseQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`\>, `"suspense"`\>
12+
- `OmitKeyof`\<[`CreateBaseQueryOptions`](CreateBaseQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`\>, `"suspense"`\>
1313

1414
## Type Parameters
1515

docs/framework/angular/reference/type-aliases/CreateMutationResult.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ Defined in: [types.ts:266](https://github.com/TanStack/query/blob/main/packages/
3131

3232
### TState
3333

34-
`TState` = `CreateStatusBasedMutationResult`\<[`CreateBaseMutationResult`](./CreateBaseMutationResult.md)\[`"status"`\], `TData`, `TError`, `TVariables`, `TOnMutateResult`\>
34+
`TState` = `CreateStatusBasedMutationResult`\<[`CreateBaseMutationResult`](CreateBaseMutationResult.md)\[`"status"`\], `TData`, `TError`, `TVariables`, `TOnMutateResult`\>

docs/framework/react/guides/prefetching.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,7 @@ Because data fetching in the component tree itself can easily lead to request wa
369369

370370
In this approach, you explicitly declare for each _route_ what data is going to be needed for that component tree, ahead of time. Because Server Rendering has traditionally needed all data to be loaded before rendering starts, this has been the dominating approach for SSR'd apps for a long time. This is still a common approach and you can read more about it in the [Server Rendering & Hydration guide](./ssr.md).
371371

372-
For now, let's focus on the client side case and look at an example of how you can make this work with [Tanstack Router](https://tanstack.com/router). These examples leave out a lot of setup and boilerplate to stay concise, you can check out a [full React Query example](./examples/basic-react-query-file-based) over in the [Tanstack Router docs](https://tanstack.com/router/latest/docs).
372+
For now, let's focus on the client side case and look at an example of how you can make this work with [Tanstack Router](https://tanstack.com/router). These examples leave out a lot of setup and boilerplate to stay concise, you can check out a [full React Query example](https://tanstack.com/router/latest/docs/framework/react/examples/basic-react-query-file-based) over in the [Tanstack Router docs](https://tanstack.com/router/latest/docs).
373373

374374
When integrating at the router level, you can choose to either _block_ rendering of that route until all data is present, or you can start a prefetch but not await the result. That way, you can start rendering the route as soon as possible. You can also mix these two approaches and await some critical data, but start rendering before all the secondary data has finished loading. In this example, we'll configure an `/article` route to not render until the article data has finished loading, as well as start prefetching comments as soon as possible, but not block rendering the route if comments haven't finished loading yet.
375375

docs/framework/solid/guides/prefetching.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ replace:
1111
'useQuery[(]': 'useQuery(() => ',
1212
'useQueries[(]': 'useQueries(() => ',
1313
'useInfiniteQuery[(]': 'useInfiniteQuery(() => ',
14-
'../examples/basic-react-query-file-based': '../examples/basic-solid-query-file-based',
14+
'/docs/framework/react/examples/basic-react-query-file-based': '/docs/framework/solid/examples/basic-solid-query-file-based',
1515
}
1616
---

docs/framework/svelte/reference/index.md

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -7,53 +7,53 @@ title: "@tanstack/svelte-query"
77

88
## Type Aliases
99

10-
- [Accessor](./type-aliases/Accessor.md)
11-
- [CreateBaseMutationResult](./type-aliases/CreateBaseMutationResult.md)
12-
- [CreateBaseQueryOptions](./type-aliases/CreateBaseQueryOptions.md)
13-
- [CreateBaseQueryResult](./type-aliases/CreateBaseQueryResult.md)
14-
- [CreateInfiniteQueryOptions](./type-aliases/CreateInfiniteQueryOptions.md)
15-
- [CreateInfiniteQueryResult](./type-aliases/CreateInfiniteQueryResult.md)
16-
- [CreateMutateAsyncFunction](./type-aliases/CreateMutateAsyncFunction.md)
17-
- [CreateMutateFunction](./type-aliases/CreateMutateFunction.md)
18-
- [CreateMutationOptions](./type-aliases/CreateMutationOptions.md)
19-
- [CreateMutationResult](./type-aliases/CreateMutationResult.md)
20-
- [CreateQueryOptions](./type-aliases/CreateQueryOptions.md)
21-
- [CreateQueryResult](./type-aliases/CreateQueryResult.md)
22-
- [DefinedCreateBaseQueryResult](./type-aliases/DefinedCreateBaseQueryResult.md)
23-
- [DefinedCreateQueryResult](./type-aliases/DefinedCreateQueryResult.md)
24-
- [DefinedInitialDataOptions](./type-aliases/DefinedInitialDataOptions.md)
25-
- [HydrationBoundary](./type-aliases/HydrationBoundary.md)
26-
- [MutationStateOptions](./type-aliases/MutationStateOptions.md)
27-
- [QueriesOptions](./type-aliases/QueriesOptions.md)
28-
- [QueriesResults](./type-aliases/QueriesResults.md)
29-
- [QueryClientProviderProps](./type-aliases/QueryClientProviderProps.md)
30-
- [UndefinedInitialDataOptions](./type-aliases/UndefinedInitialDataOptions.md)
10+
- [Accessor](type-aliases/Accessor.md)
11+
- [CreateBaseMutationResult](type-aliases/CreateBaseMutationResult.md)
12+
- [CreateBaseQueryOptions](type-aliases/CreateBaseQueryOptions.md)
13+
- [CreateBaseQueryResult](type-aliases/CreateBaseQueryResult.md)
14+
- [CreateInfiniteQueryOptions](type-aliases/CreateInfiniteQueryOptions.md)
15+
- [CreateInfiniteQueryResult](type-aliases/CreateInfiniteQueryResult.md)
16+
- [CreateMutateAsyncFunction](type-aliases/CreateMutateAsyncFunction.md)
17+
- [CreateMutateFunction](type-aliases/CreateMutateFunction.md)
18+
- [CreateMutationOptions](type-aliases/CreateMutationOptions.md)
19+
- [CreateMutationResult](type-aliases/CreateMutationResult.md)
20+
- [CreateQueryOptions](type-aliases/CreateQueryOptions.md)
21+
- [CreateQueryResult](type-aliases/CreateQueryResult.md)
22+
- [DefinedCreateBaseQueryResult](type-aliases/DefinedCreateBaseQueryResult.md)
23+
- [DefinedCreateQueryResult](type-aliases/DefinedCreateQueryResult.md)
24+
- [DefinedInitialDataOptions](type-aliases/DefinedInitialDataOptions.md)
25+
- [HydrationBoundary](type-aliases/HydrationBoundary.md)
26+
- [MutationStateOptions](type-aliases/MutationStateOptions.md)
27+
- [QueriesOptions](type-aliases/QueriesOptions.md)
28+
- [QueriesResults](type-aliases/QueriesResults.md)
29+
- [QueryClientProviderProps](type-aliases/QueryClientProviderProps.md)
30+
- [UndefinedInitialDataOptions](type-aliases/UndefinedInitialDataOptions.md)
3131

3232
## Variables
3333

34-
- [HydrationBoundary](./variables/HydrationBoundary.md)
34+
- [HydrationBoundary](variables/HydrationBoundary.md)
3535

3636
## Functions
3737

38-
- [createInfiniteQuery](./functions/createInfiniteQuery.md)
39-
- [createMutation](./functions/createMutation.md)
40-
- [createQueries](./functions/createQueries.md)
41-
- [createQuery](./functions/createQuery.md)
42-
- [getIsRestoringContext](./functions/getIsRestoringContext.md)
43-
- [getQueryClientContext](./functions/getQueryClientContext.md)
44-
- [infiniteQueryOptions](./functions/infiniteQueryOptions.md)
45-
- [queryOptions](./functions/queryOptions.md)
46-
- [setIsRestoringContext](./functions/setIsRestoringContext.md)
47-
- [setQueryClientContext](./functions/setQueryClientContext.md)
48-
- [useHydrate](./functions/useHydrate.md)
49-
- [useIsFetching](./functions/useIsFetching.md)
50-
- [useIsMutating](./functions/useIsMutating.md)
51-
- [useIsRestoring](./functions/useIsRestoring.md)
52-
- [useMutationState](./functions/useMutationState.md)
53-
- [useQueryClient](./functions/useQueryClient.md)
38+
- [createInfiniteQuery](functions/createInfiniteQuery.md)
39+
- [createMutation](functions/createMutation.md)
40+
- [createQueries](functions/createQueries.md)
41+
- [createQuery](functions/createQuery.md)
42+
- [getIsRestoringContext](functions/getIsRestoringContext.md)
43+
- [getQueryClientContext](functions/getQueryClientContext.md)
44+
- [infiniteQueryOptions](functions/infiniteQueryOptions.md)
45+
- [queryOptions](functions/queryOptions.md)
46+
- [setIsRestoringContext](functions/setIsRestoringContext.md)
47+
- [setQueryClientContext](functions/setQueryClientContext.md)
48+
- [useHydrate](functions/useHydrate.md)
49+
- [useIsFetching](functions/useIsFetching.md)
50+
- [useIsMutating](functions/useIsMutating.md)
51+
- [useIsRestoring](functions/useIsRestoring.md)
52+
- [useMutationState](functions/useMutationState.md)
53+
- [useQueryClient](functions/useQueryClient.md)
5454

5555
## References
5656

5757
### QueryClientProvider
5858

59-
Renames and re-exports [HydrationBoundary](./variables/HydrationBoundary.md)
59+
Renames and re-exports [HydrationBoundary](variables/HydrationBoundary.md)

scripts/verify-links.ts

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -104,16 +104,6 @@ async function verifyMarkdownLinks() {
104104

105105
if (relativeLinks.length > 0) {
106106
relativeLinks.forEach((link) => {
107-
if (!link.startsWith('.')) {
108-
errors.push({
109-
link,
110-
file,
111-
resolvedPath: '',
112-
reason: 'Does not start with ./ or ../',
113-
})
114-
return
115-
}
116-
117107
relativeLinkExists(link, file)
118108
})
119109
}

0 commit comments

Comments
 (0)