Skip to content

Commit 2406435

Browse files
docs(react-query): fix broken links in QueryClient docs (#8748)
Co-authored-by: Lachlan Collins <1667261+lachlancollins@users.noreply.github.com>
1 parent e67b6f6 commit 2406435

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

‎docs/reference/QueryClient.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Its available methods are:
6363
- `defaultOptions?: DefaultOptions`
6464
- Optional
6565
- Define defaults for all queries and mutations using this queryClient.
66-
- You can also define defaults to be used for [hydration](../../framework/react/reference/hydration)
66+
- You can also define defaults to be used for [hydration](../framework/react/reference/hydration)
6767

6868
## `queryClient.fetchQuery`
6969

@@ -95,7 +95,7 @@ try {
9595

9696
**Options**
9797

98-
The options for `fetchQuery` are exactly the same as those of [`useQuery`](../../framework/react/reference/useQuery), except the following: `enabled, refetchInterval, refetchIntervalInBackground, refetchOnWindowFocus, refetchOnReconnect, refetchOnMount, notifyOnChangeProps, throwOnError, select, suspense, placeholderData`; which are strictly for useQuery and useInfiniteQuery. You can check the [source code](https://github.com/TanStack/query/blob/7cd2d192e6da3df0b08e334ea1cf04cd70478827/packages/query-core/src/types.ts#L119) for more clarity.
98+
The options for `fetchQuery` are exactly the same as those of [`useQuery`](../framework/react/reference/useQuery), except the following: `enabled, refetchInterval, refetchIntervalInBackground, refetchOnWindowFocus, refetchOnReconnect, refetchOnMount, notifyOnChangeProps, throwOnError, select, suspense, placeholderData`; which are strictly for useQuery and useInfiniteQuery. You can check the [source code](https://github.com/TanStack/query/blob/7cd2d192e6da3df0b08e334ea1cf04cd70478827/packages/query-core/src/types.ts#L119) for more clarity.
9999

100100
**Returns**
101101

@@ -172,7 +172,7 @@ const data = queryClient.getQueryData(queryKey)
172172

173173
**Options**
174174

175-
- `queryKey: QueryKey`: [Query Keys](../../framework/react/guides/query-keys)
175+
- `queryKey: QueryKey`: [Query Keys](../framework/react/guides/query-keys)
176176

177177
**Returns**
178178

@@ -234,7 +234,7 @@ const data = queryClient.getQueriesData(filters)
234234

235235
**Options**
236236

237-
- `filters: QueryFilters`: [Query Filters](../../framework/react/guides/filters#query-filters)
237+
- `filters: QueryFilters`: [Query Filters](../framework/react/guides/filters#query-filters)
238238
- if a filter is passed, the data with queryKeys matching the filter will be returned
239239

240240
**Returns**
@@ -260,7 +260,7 @@ queryClient.setQueryData(queryKey, updater)
260260

261261
**Options**
262262

263-
- `queryKey: QueryKey`: [Query Keys](../../framework/react/guides/query-keys)
263+
- `queryKey: QueryKey`: [Query Keys](../framework/react/guides/query-keys)
264264
- `updater: TQueryFnData | undefined | ((oldData: TQueryFnData | undefined) => TQueryFnData | undefined)`
265265
- If non-function is passed, the data will be updated to this value
266266
- If a function is passed, it will receive the old data value and be expected to return a new one.
@@ -298,7 +298,7 @@ console.log(state.dataUpdatedAt)
298298

299299
**Options**
300300

301-
- `queryKey: QueryKey`: [Query Keys](../../framework/react/guides/query-keys)
301+
- `queryKey: QueryKey`: [Query Keys](../framework/react/guides/query-keys)
302302

303303
## `queryClient.setQueriesData`
304304

@@ -310,7 +310,7 @@ queryClient.setQueriesData(filters, updater)
310310

311311
**Options**
312312

313-
- `filters: QueryFilters`: [Query Filters](../../framework/react/guides/filters#query-filters)
313+
- `filters: QueryFilters`: [Query Filters](../framework/react/guides/filters#query-filters)
314314
- if a filter is passed, queryKeys matching the filter will be updated
315315
- `updater: TQueryFnData | (oldData: TQueryFnData | undefined) => TQueryFnData`
316316
- the [setQueryData](#queryclientsetquerydata) updater function or new data, will be called for each matching queryKey
@@ -335,8 +335,8 @@ await queryClient.invalidateQueries(
335335

336336
**Options**
337337

338-
- `filters?: QueryFilters`: [Query Filters](../../framework/react/guides/filters#query-filters)
339-
- `queryKey?: QueryKey`: [Query Keys](../../framework/react/guides/query-keys)
338+
- `filters?: QueryFilters`: [Query Filters](../framework/react/guides/filters#query-filters)
339+
- `queryKey?: QueryKey`: [Query Keys](../framework/react/guides/query-keys)
340340
- `refetchType?: 'active' | 'inactive' | 'all' | 'none'`
341341
- Defaults to `'active'`
342342
- When set to `active`, only queries that match the refetch predicate and are actively being rendered via `useQuery` and friends will be refetched in the background.
@@ -377,7 +377,7 @@ await queryClient.refetchQueries({
377377

378378
**Options**
379379

380-
- `filters?: QueryFilters`: [Query Filters](../../framework/react/guides/filters#query-filters)
380+
- `filters?: QueryFilters`: [Query Filters](../framework/react/guides/filters#query-filters)
381381
- `options?: RefetchOptions`:
382382
- `throwOnError?: boolean`
383383
- When set to `true`, this method will throw if any of the query refetch tasks fail.
@@ -402,7 +402,7 @@ await queryClient.cancelQueries({ queryKey: ['posts'], exact: true })
402402

403403
**Options**
404404

405-
- `filters?: QueryFilters`: [Query Filters](../../framework/react/guides/filters#query-filters)
405+
- `filters?: QueryFilters`: [Query Filters](../framework/react/guides/filters#query-filters)
406406

407407
**Returns**
408408

@@ -418,7 +418,7 @@ queryClient.removeQueries({ queryKey, exact: true })
418418

419419
**Options**
420420

421-
- `filters?: QueryFilters`: [Query Filters](../../framework/react/guides/filters#query-filters)
421+
- `filters?: QueryFilters`: [Query Filters](../framework/react/guides/filters#query-filters)
422422

423423
**Returns**
424424

@@ -441,7 +441,7 @@ queryClient.resetQueries({ queryKey, exact: true })
441441

442442
**Options**
443443

444-
- `filters?: QueryFilters`: [Query Filters](../../framework/react/guides/filters#query-filters)
444+
- `filters?: QueryFilters`: [Query Filters](../framework/react/guides/filters#query-filters)
445445
- `options?: ResetOptions`:
446446
- `throwOnError?: boolean`
447447
- When set to `true`, this method will throw if any of the query refetch tasks fail.
@@ -464,11 +464,11 @@ if (queryClient.isFetching()) {
464464
}
465465
```
466466

467-
TanStack Query also exports a handy [`useIsFetching`](../../framework/react/reference/useIsFetching) hook that will let you subscribe to this state in your components without creating a manual subscription to the query cache.
467+
TanStack Query also exports a handy [`useIsFetching`](../framework/react/reference/useIsFetching) hook that will let you subscribe to this state in your components without creating a manual subscription to the query cache.
468468

469469
**Options**
470470

471-
- `filters?: QueryFilters`: [Query Filters](../../framework/react/guides/filters#query-filters)
471+
- `filters?: QueryFilters`: [Query Filters](../framework/react/guides/filters#query-filters)
472472

473473
**Returns**
474474

@@ -484,11 +484,11 @@ if (queryClient.isMutating()) {
484484
}
485485
```
486486

487-
TanStack Query also exports a handy [`useIsMutating`](../../framework/react/reference/useIsMutating) hook that will let you subscribe to this state in your components without creating a manual subscription to the mutation cache.
487+
TanStack Query also exports a handy [`useIsMutating`](../framework/react/reference/useIsMutating) hook that will let you subscribe to this state in your components without creating a manual subscription to the mutation cache.
488488

489489
**Options**
490490

491-
- `filters: MutationFilters`: [Mutation Filters](../../framework/react/guides/filters#mutation-filters)
491+
- `filters: MutationFilters`: [Mutation Filters](../framework/react/guides/filters#mutation-filters)
492492

493493
**Returns**
494494

@@ -539,7 +539,7 @@ function Component() {
539539

540540
**Options**
541541

542-
- `queryKey: QueryKey`: [Query Keys](../../framework/react/guides/query-keys)
542+
- `queryKey: QueryKey`: [Query Keys](../framework/react/guides/query-keys)
543543
- `options: QueryOptions`
544544

545545
> As stated in [`getQueryDefaults`](#queryclientgetquerydefaults), the order of registration of query defaults does matter.

0 commit comments

Comments
 (0)