Skip to content

Commit af54581

Browse files
docs: replace v4 tanstack query links with latest (#7133)
1 parent fbc106c commit af54581

File tree

38 files changed

+98
-98
lines changed

38 files changed

+98
-98
lines changed

documentation/docs/audit-logs/hooks/use-log/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@ mutate({
5757

5858
### Return value
5959

60-
| Description | Type |
61-
| ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
62-
| Result of the `react-query`'s useMutation | [`UseMutationResult<{ data: TData}, TError, { id: BaseKey; name: string; }, unknown>`](https://tanstack.com/query/v4/docs/framework/react/reference/useMutation) |
60+
| Description | Type |
61+
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
62+
| Result of the `react-query`'s useMutation | [`UseMutationResult<{ data: TData}, TError, { id: BaseKey; name: string; }, unknown>`](https://tanstack.com/query/v5/docs/react/reference/useMutation) |
6363

6464
## rename
6565

@@ -94,6 +94,6 @@ mutate({
9494

9595
### Return value
9696

97-
| Description | Type |
98-
| ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
99-
| Result of the `react-query`'s useMutation | [`UseMutationResult<{ data: TData}, TError, { id: BaseKey; name: string; }, unknown>`](https://tanstack.com/query/v4/docs/framework/react/reference/useMutation) |
97+
| Description | Type |
98+
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
99+
| Result of the `react-query`'s useMutation | [`UseMutationResult<{ data: TData}, TError, { id: BaseKey; name: string; }, unknown>`](https://tanstack.com/query/v5/docs/react/reference/useMutation) |

documentation/docs/authentication/hooks/use-forgot-password/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ source: /packages/core/src/hooks/auth/useForgotPassword/index.ts
66

77
`useForgotPassword` calls the `forgotPassword` method from [`authProvider`](/docs/authentication/auth-provider) under the hood.
88

9-
It returns the result of `react-query`'s [useMutation](https://tanstack.com/query/v4/docs/framework/react/reference/useMutation) which includes many properties, some of which being `isSuccess` and `isError`.
9+
It returns the result of `react-query`'s [useMutation](https://tanstack.com/query/v5/docs/react/reference/useMutation) which includes many properties, some of which being `isSuccess` and `isError`.
1010

1111
Data that is resolved from `forgotPassword` will be returned as the `data` in the query result with the following type:
1212

documentation/docs/authentication/hooks/use-login/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ source: /packages/core/src/hooks/auth/useLogin/index.ts
66

77
`useLogin` calls `login` method from [`authProvider`](/docs/authentication/auth-provider) under the hood.
88

9-
It returns the result of `react-query`'s [useMutation](https://tanstack.com/query/v4/docs/framework/react/reference/useMutation) which includes many properties, some of which being `isSuccess` and `isError`.
9+
It returns the result of `react-query`'s [useMutation](https://tanstack.com/query/v5/docs/react/reference/useMutation) which includes many properties, some of which being `isSuccess` and `isError`.
1010

1111
Data that is resolved from `login` will be returned as the `data` in the query result with the following type:
1212

documentation/docs/authentication/hooks/use-logout/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ source: /packages/core/src/hooks/auth/useLogout/index.ts
66

77
`useLogout` calls the `logout` method from the [`authProvider`](/docs/authentication/auth-provider) under the hood.
88

9-
It returns the result of `react-query`'s [useMutation](https://tanstack.com/query/v4/docs/framework/react/reference/useMutation) which includes many properties, some of which being `isSuccess` and `isError`.
9+
It returns the result of `react-query`'s [useMutation](https://tanstack.com/query/v5/docs/react/reference/useMutation) which includes many properties, some of which being `isSuccess` and `isError`.
1010

1111
Data that is resolved from `logout` will be returned as the `data` in the query result with the following type:
1212

documentation/docs/authentication/hooks/use-on-error/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ source: /packages/core/src/hooks/auth/useOnError/index.ts
66

77
`useOnError` calls the [`onError`][on-error] method from the [`authProvider`][auth-provider] under the hood.
88

9-
It returns the result of `react-query`'s [useMutation](https://tanstack.com/query/v4/docs/react/reference/useMutation), which includes many properties like `isSuccess` and `isError`.
9+
It returns the result of `react-query`'s [useMutation](https://tanstack.com/query/v5/docs/react/reference/useMutation), which includes many properties like `isSuccess` and `isError`.
1010

1111
Data that is resolved from the [`onError`][on-error] will be returned as the `data` in the query result with the following type:
1212

documentation/docs/authentication/hooks/use-register/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ source: /packages/core/src/hooks/auth/useRegister/index.ts
66

77
`useRegister` calls `register` method from [`authProvider`](/docs/authentication/auth-provider) under the hood.
88

9-
It returns the result of `react-query`'s [useMutation](https://tanstack.com/query/v4/docs/framework/react/reference/useMutation) which includes many properties, some of which being isSuccess and isError.
9+
It returns the result of `react-query`'s [useMutation](https://tanstack.com/query/v5/docs/react/reference/useMutation) which includes many properties, some of which being isSuccess and isError.
1010

1111
Data that is resolved from `register` will be returned as the `data` in the query result with the following type:
1212

documentation/docs/authentication/hooks/use-update-password/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ source: /packages/core/src/hooks/auth/useUpdatePassword/index.ts
66

77
`useUpdatePassword` calls `updatePassword` method from [`authProvider`](/docs/authentication/auth-provider) under the hood.
88

9-
It returns the result of `react-query`'s [useMutation](https://tanstack.com/query/v4/docs/framework/react/reference/useMutation).
9+
It returns the result of `react-query`'s [useMutation](https://tanstack.com/query/v5/docs/react/reference/useMutation).
1010

1111
Data that is resolved from `updatePassword` will be returned as the `data` in the query result with the following type:
1212

documentation/docs/authorization/hooks/use-can/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,5 +136,5 @@ const MyComponent = () => {
136136
[access-control-provider]: /docs/authorization/access-control-provider
137137
[use-query]: https://tanstack.com/query/latest/docs/react/guides/queries
138138
[tanstack-query]: https://tanstack.com/query/latest
139-
[query-options]: https://tanstack.com/query/v4/docs/react/reference/useQuery
139+
[query-options]: https://tanstack.com/query/v5/docs/react/reference/useQuery
140140
[can-params]: /docs/core/interface-references#canparams

documentation/docs/core/interface-references/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ type GraphQLQueryOptions = {
215215

216216
### QueryFunctionContext
217217

218-
Context to be passed to the query function. Refer to [Query Function Context](https://tanstack.com/query/v4/docs/guides/query-functions#queryfunctioncontext) for more information.
218+
Context to be passed to the query function. Refer to [Query Function Context](https://tanstack.com/query/v5/docs/react/guides/query-functions#queryfunctioncontext) for more information.
219219

220220
### QueryBuilderOptions
221221

documentation/docs/data/hooks/use-create-many/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: useCreateMany
33
source: packages/core/src/hooks/data/useCreateMany.ts
44
---
55

6-
`useCreateMany` is used for creating multiple records. It is an extended version of TanStack Query's [`useMutation`](https://tanstack.com/query/v4/docs/react/reference/useMutation) and not only supports all features of the mutation but also adds some extra features.
6+
`useCreateMany` is used for creating multiple records. It is an extended version of TanStack Query's [`useMutation`](https://tanstack.com/query/v5/docs/react/reference/useMutation) and not only supports all features of the mutation but also adds some extra features.
77

88
It uses the `createMany` method as the **mutation function** from the [`dataProvider`](/docs/data/data-provider) which is passed to `<Refine />`.
99

@@ -51,7 +51,7 @@ When the `useCreateMany` mutation runs successfully, it will call the `publish`
5151

5252
When the `useCreateMany` mutation runs successfully, it will invalidate the following queries from the current `resource`: `"list"` and `"many"` by default. Which means that, if you use `useList` or `useMany` hooks in the same page, they will refetch the data after the mutation is completed. You can change this behavior by passing [`invalidates`](#invalidates) prop.
5353

54-
> For more information, refer to the [invalidation documentation &#8594](https://tanstack.com/query/v4/docs/react/guides/query-invalidation)
54+
> For more information, refer to the [invalidation documentation &#8594](https://tanstack.com/query/v5/docs/react/guides/query-invalidation)
5555
5656
## Audit Logs
5757

@@ -65,7 +65,7 @@ When the `useCreateMany` mutation runs successfully, it will call the `log` meth
6565

6666
`mutationOptions` is used to pass options to the `useMutation` hook. It is useful when you want to pass additional options to the `useMutation` hook.
6767

68-
[Refer to the `useMutation` documentation for more information &#8594](https://tanstack.com/query/v4/docs/react/reference/useMutation)
68+
[Refer to the `useMutation` documentation for more information &#8594](https://tanstack.com/query/v5/docs/react/reference/useMutation)
6969

7070
```tsx
7171
useCreateMany({
@@ -282,7 +282,7 @@ mutate({
282282

283283
Returns an object with TanStack Query's `useMutation` return values.
284284

285-
> For more information, refer to the [`useMutation` documentation &#8594](https://tanstack.com/query/v4/docs/react/reference/useMutation)
285+
> For more information, refer to the [`useMutation` documentation &#8594](https://tanstack.com/query/v5/docs/react/reference/useMutation)
286286
287287
### Additional Values
288288

@@ -322,7 +322,7 @@ console.log(overtime.elapsedTime); // undefined, 1000, 2000, 3000 4000, ...
322322

323323
| Property | Description | Type |
324324
| ----------- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
325-
| mutation | Result of the TanStack Query's useMutation | [`UseMutationResult<{ data: TData[]}, TError, { resource: string; values: TVariables[]; }, unknown>`](https://tanstack.com/query/v4/docs/react/reference/useMutation) |
325+
| mutation | Result of the TanStack Query's useMutation | [`UseMutationResult<{ data: TData[]}, TError, { resource: string; values: TVariables[]; }, unknown>`](https://tanstack.com/query/v5/docs/react/reference/useMutation) |
326326
| mutate | Mutation function | `(params?: { resource?: string, values?: TVariables[], ... }) => void` |
327327
| mutateAsync | Async mutation function | `(params?: { resource?: string, values?: TVariables[], ... }) => Promise<{ data: TData[] }>` |
328328
| overtime | Overtime loading information | `{ elapsedTime?: number }` |

0 commit comments

Comments
 (0)