From de91d430742e7f3fa64984f901dc652ab2ee30bd Mon Sep 17 00:00:00 2001 From: phryneas Date: Fri, 19 Jul 2024 14:23:17 +0000 Subject: [PATCH] Update Docs --- docs/client-react-streaming.transportedqueryref.md | 6 +++--- .../client-react-streaming.transportedqueryref.topromise.md | 6 +++--- docs/experimental-nextjs-app-support.transportedqueryref.md | 6 +++--- ...ntal-nextjs-app-support.transportedqueryref.topromise.md | 6 +++--- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/client-react-streaming.transportedqueryref.md b/docs/client-react-streaming.transportedqueryref.md index 0bfaf61b..e6a86313 100644 --- a/docs/client-react-streaming.transportedqueryref.md +++ b/docs/client-react-streaming.transportedqueryref.md @@ -48,14 +48,14 @@ Description -() => Promise<[TransportedQueryRef](./client-react-streaming.transportedqueryref.md)> +undefined -_(Optional)_ Only available in React Server Components. Will be `undefined` after being passed to Client Components. +_(Optional)_ Temporarily disabled - see https://github.com/apollographql/apollo-client-nextjs/issues/332 -Returns a promise that resolves back to the `TransportedQueryRef` that can be awaited in RSC to suspend a subtree until the originating query has been loaded. +Will now be be `undefined` both in React Server Components and Client Components until we can find a better resolution. diff --git a/docs/client-react-streaming.transportedqueryref.topromise.md b/docs/client-react-streaming.transportedqueryref.topromise.md index ece19dbf..4b7c15a6 100644 --- a/docs/client-react-streaming.transportedqueryref.topromise.md +++ b/docs/client-react-streaming.transportedqueryref.topromise.md @@ -4,12 +4,12 @@ ## TransportedQueryRef.toPromise property -Only available in React Server Components. Will be `undefined` after being passed to Client Components. +Temporarily disabled - see https://github.com/apollographql/apollo-client-nextjs/issues/332 -Returns a promise that resolves back to the `TransportedQueryRef` that can be awaited in RSC to suspend a subtree until the originating query has been loaded. +Will now be be `undefined` both in React Server Components and Client Components until we can find a better resolution. **Signature:** ```typescript -toPromise?: () => Promise; +toPromise?: undefined; ``` diff --git a/docs/experimental-nextjs-app-support.transportedqueryref.md b/docs/experimental-nextjs-app-support.transportedqueryref.md index 0c540fd5..a48b1083 100644 --- a/docs/experimental-nextjs-app-support.transportedqueryref.md +++ b/docs/experimental-nextjs-app-support.transportedqueryref.md @@ -48,14 +48,14 @@ Description -() => Promise<[TransportedQueryRef](./experimental-nextjs-app-support.transportedqueryref.md)> +undefined -_(Optional)_ Only available in React Server Components. Will be `undefined` after being passed to Client Components. +_(Optional)_ Temporarily disabled - see https://github.com/apollographql/apollo-client-nextjs/issues/332 -Returns a promise that resolves back to the `TransportedQueryRef` that can be awaited in RSC to suspend a subtree until the originating query has been loaded. +Will now be be `undefined` both in React Server Components and Client Components until we can find a better resolution. diff --git a/docs/experimental-nextjs-app-support.transportedqueryref.topromise.md b/docs/experimental-nextjs-app-support.transportedqueryref.topromise.md index 8b07dd41..3c3890e5 100644 --- a/docs/experimental-nextjs-app-support.transportedqueryref.topromise.md +++ b/docs/experimental-nextjs-app-support.transportedqueryref.topromise.md @@ -4,12 +4,12 @@ ## TransportedQueryRef.toPromise property -Only available in React Server Components. Will be `undefined` after being passed to Client Components. +Temporarily disabled - see https://github.com/apollographql/apollo-client-nextjs/issues/332 -Returns a promise that resolves back to the `TransportedQueryRef` that can be awaited in RSC to suspend a subtree until the originating query has been loaded. +Will now be be `undefined` both in React Server Components and Client Components until we can find a better resolution. **Signature:** ```typescript -toPromise?: () => Promise; +toPromise?: undefined; ```