Update Docs

apollographql · Jul 19, 2024 · de91d43 · de91d43
1 parent aa73e9d
commit de91d43
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 12 deletions.
diff --git a/docs/client-react-streaming.transportedqueryref.md b/docs/client-react-streaming.transportedqueryref.md
@@ -48,14 +48,14 @@ Description
 
 </td><td>
 
-() =&gt; Promise&lt;[TransportedQueryRef](./client-react-streaming.transportedqueryref.md)<!-- -->&gt;
+undefined
 
 
 </td><td>
 
-_(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.
 
 
 </td></tr>

diff --git 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<TransportedQueryRef>;
+toPromise?: undefined;
 ```
diff --git a/docs/experimental-nextjs-app-support.transportedqueryref.md b/docs/experimental-nextjs-app-support.transportedqueryref.md
@@ -48,14 +48,14 @@ Description
 
 </td><td>
 
-() =&gt; Promise&lt;[TransportedQueryRef](./experimental-nextjs-app-support.transportedqueryref.md)<!-- -->&gt;
+undefined
 
 
 </td><td>
 
-_(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.
 
 
 </td></tr>

diff --git 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<TransportedQueryRef>;
+toPromise?: undefined;
 ```