From 3ca8103242932087f33b42bc8693fb1e291285f6 Mon Sep 17 00:00:00 2001 From: Romain Trotard Date: Tue, 27 Aug 2024 07:38:31 +0200 Subject: [PATCH 1/2] docs: Add known limitation about cancellation with suspense hooks --- docs/framework/react/guides/query-cancellation.md | 5 +++++ docs/framework/react/reference/useSuspenseInfiniteQuery.md | 5 +++++ docs/framework/react/reference/useSuspenseQueries.md | 5 ++++- docs/framework/react/reference/useSuspenseQuery.md | 5 +++++ 4 files changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/framework/react/guides/query-cancellation.md b/docs/framework/react/guides/query-cancellation.md index 3e8545c0aa..7d40399619 100644 --- a/docs/framework/react/guides/query-cancellation.md +++ b/docs/framework/react/guides/query-cancellation.md @@ -187,3 +187,8 @@ return ( ``` [//]: # 'Example7' + +## Limitations + +Cancelation does not work when working with `Suspense` hooks: `useSuspenseQuery`, `useSuspenseQueries` and `useSuspenseInfiniteQuery`. + diff --git a/docs/framework/react/reference/useSuspenseInfiniteQuery.md b/docs/framework/react/reference/useSuspenseInfiniteQuery.md index 06e81cbb23..b10b666ffc 100644 --- a/docs/framework/react/reference/useSuspenseInfiniteQuery.md +++ b/docs/framework/react/reference/useSuspenseInfiniteQuery.md @@ -24,3 +24,8 @@ Same object as [useInfiniteQuery](../useInfiniteQuery), except that: - `isPlaceholderData` is missing - `status` is always `success` - the derived flags are set accordingly. + +**Caveat** + +[Cancelation](../guides/query-cancellation.md) does not work. + diff --git a/docs/framework/react/reference/useSuspenseQueries.md b/docs/framework/react/reference/useSuspenseQueries.md index 549bfe9022..47813efe37 100644 --- a/docs/framework/react/reference/useSuspenseQueries.md +++ b/docs/framework/react/reference/useSuspenseQueries.md @@ -25,6 +25,9 @@ Same structure as [useQueries](../useQueries), except that for each `query`: - `status` is always `success` - the derived flags are set accordingly. -**Caveat** +**Caveats** Keep in mind that the component will only re-mount after **all queries** have finished loading. Hence, if a query has gone stale in the time it took for all the queries to complete, it will be fetched again at re-mount. To avoid this, make sure to set a high enough `staleTime`. + +[Cancelation](../guides/query-cancellation.md) does not work. + diff --git a/docs/framework/react/reference/useSuspenseQuery.md b/docs/framework/react/reference/useSuspenseQuery.md index 7bb04f60e5..379fe97083 100644 --- a/docs/framework/react/reference/useSuspenseQuery.md +++ b/docs/framework/react/reference/useSuspenseQuery.md @@ -23,3 +23,8 @@ Same object as [useQuery](../useQuery), except that: - `isPlaceholderData` is missing - `status` is always `success` - the derived flags are set accordingly. + +**Caveat** + +[Cancelation](../guides/query-cancellation.md) does not work. + From d78b7d3dd3e14b939e70f6ed1aaad58b4126ccc0 Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Tue, 27 Aug 2024 16:20:35 +0000 Subject: [PATCH 2/2] ci: apply automated fixes --- docs/framework/react/guides/query-cancellation.md | 1 - docs/framework/react/reference/useSuspenseInfiniteQuery.md | 1 - docs/framework/react/reference/useSuspenseQueries.md | 1 - docs/framework/react/reference/useSuspenseQuery.md | 1 - 4 files changed, 4 deletions(-) diff --git a/docs/framework/react/guides/query-cancellation.md b/docs/framework/react/guides/query-cancellation.md index 7d40399619..efbf0eb351 100644 --- a/docs/framework/react/guides/query-cancellation.md +++ b/docs/framework/react/guides/query-cancellation.md @@ -191,4 +191,3 @@ return ( ## Limitations Cancelation does not work when working with `Suspense` hooks: `useSuspenseQuery`, `useSuspenseQueries` and `useSuspenseInfiniteQuery`. - diff --git a/docs/framework/react/reference/useSuspenseInfiniteQuery.md b/docs/framework/react/reference/useSuspenseInfiniteQuery.md index b10b666ffc..0f69233d6d 100644 --- a/docs/framework/react/reference/useSuspenseInfiniteQuery.md +++ b/docs/framework/react/reference/useSuspenseInfiniteQuery.md @@ -28,4 +28,3 @@ Same object as [useInfiniteQuery](../useInfiniteQuery), except that: **Caveat** [Cancelation](../guides/query-cancellation.md) does not work. - diff --git a/docs/framework/react/reference/useSuspenseQueries.md b/docs/framework/react/reference/useSuspenseQueries.md index 47813efe37..7da4f3fb48 100644 --- a/docs/framework/react/reference/useSuspenseQueries.md +++ b/docs/framework/react/reference/useSuspenseQueries.md @@ -30,4 +30,3 @@ Same structure as [useQueries](../useQueries), except that for each `query`: Keep in mind that the component will only re-mount after **all queries** have finished loading. Hence, if a query has gone stale in the time it took for all the queries to complete, it will be fetched again at re-mount. To avoid this, make sure to set a high enough `staleTime`. [Cancelation](../guides/query-cancellation.md) does not work. - diff --git a/docs/framework/react/reference/useSuspenseQuery.md b/docs/framework/react/reference/useSuspenseQuery.md index 379fe97083..3c2ab660eb 100644 --- a/docs/framework/react/reference/useSuspenseQuery.md +++ b/docs/framework/react/reference/useSuspenseQuery.md @@ -27,4 +27,3 @@ Same object as [useQuery](../useQuery), except that: **Caveat** [Cancelation](../guides/query-cancellation.md) does not work. -