Skip to content

Commit c430110

Browse files
authored
Merge branch 'main' into update-react-patterns
2 parents 19e948d + 6087f72 commit c430110

31 files changed

Lines changed: 191 additions & 184 deletions

File tree

.changeset/olive-crabs-learn.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
"@refinedev/core": patch
3+
---
4+
5+
[chore: replace outdated and broken `@tanstack/query` links](https://github.com/refinedev/refine/pull/6889)
6+
7+
Updated broken links to `@tanstack/query` documentation for `useMutation` in TSDoc definitions.

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://react-query.tanstack.com/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/v4/docs/framework/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://react-query.tanstack.com/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/v4/docs/framework/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://react-query.tanstack.com/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/v4/docs/framework/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://react-query.tanstack.com/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/v4/docs/framework/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://react-query.tanstack.com/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/v4/docs/framework/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-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://react-query.tanstack.com/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/v4/docs/framework/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://react-query.tanstack.com/reference/useMutation).
9+
It returns the result of `react-query`'s [useMutation](https://tanstack.com/query/v4/docs/framework/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/data/hooks/use-form/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -497,7 +497,7 @@ These props have default values in `RefineContext` and can also be set on [`<Ref
497497
| ------------- | ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
498498
| onFinish | Triggers the mutation | `(values: TVariables) => Promise<CreateResponse<TData>` \| `UpdateResponse<TData>` \| `void`> |
499499
| query | Result of the query of a record | [`QueryObserverResult<TData, TError>`](https://react-query.tanstack.com/reference/useQuery) |
500-
| mutation | Result of the mutation triggered by calling `onFinish` | [`UseMutationResult<T>`](https://react-query.tanstack.com/reference/useMutation) |
500+
| mutation | Result of the mutation triggered by calling `onFinish` | [`UseMutationResult<T>`](https://tanstack.com/query/v4/docs/framework/react/reference/useMutation) |
501501
| formLoading | Loading state of form request | `boolean` |
502502
| id | Record id for `clone` and `create` action | [`BaseKey`](/docs/core/interface-references#basekey) |
503503
| setId | `id` setter | `Dispatch<SetStateAction<` `string` \| `number` \| `undefined>>` |

documentation/docs/ui-integrations/ant-design/hooks/use-editable-table/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,7 @@ Takes a `id` as a parameter and returns `true` if the given `BaseKey` is equal t
364364
[useform]: /docs/ui-integrations/ant-design/hooks/use-table
365365
[usetable]: /docs/ui-integrations/ant-design/hooks/use-table
366366
[usequery]: https://react-query.tanstack.com/reference/useQuery
367-
[usemutation]: https://react-query.tanstack.com/reference/useMutation
367+
[usemutation]: https://tanstack.com/query/v4/docs/framework/react/reference/useMutation
368368
[baserecord]: /docs/core/interface-references#baserecord
369369
[basekey]: /docs/core/interface-references#basekey
370370
[crudsorting]: /docs/core/interface-references#crudsorting

documentation/docs/ui-integrations/ant-design/hooks/use-form/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1180,7 +1180,7 @@ You can use the `meta` property to pass common values to the mutation and the qu
11801180
| saveButtonProps | Props for a submit button | `{ disabled: boolean; onClick: () => void; loading?:boolean; }` |
11811181
| redirect | Redirect function for custom redirections | `(redirect:` `"list"`\|`"edit"`\|`"show"`\|`"create"`\| `false` ,`idFromFunction?:` [`BaseKey`](/docs/core/interface-references#basekey)\|`undefined`) => `data` |
11821182
| query | Result of the query of a record | [`QueryObserverResult<T>`](https://react-query.tanstack.com/reference/useQuery) |
1183-
| mutation | Result of the mutation triggered by submitting the form | [`UseMutationResult<T>`](https://react-query.tanstack.com/reference/useMutation) |
1183+
| mutation | Result of the mutation triggered by submitting the form | [`UseMutationResult<T>`](https://tanstack.com/query/v4/docs/framework/react/reference/useMutation) |
11841184
| formLoading | Loading state of form request | `boolean` |
11851185
| id | Record id for `clone` and `create` action | [`BaseKey`](/docs/core/interface-references#basekey) |
11861186
| setId | `id` setter | `Dispatch<SetStateAction<` `string` \| `number` \| `undefined>>` |

0 commit comments

Comments
 (0)