-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
20c0808
commit 553f542
Showing
19 changed files
with
359 additions
and
189 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
49 changes: 49 additions & 0 deletions
49
docs/client-react-streaming.inmemorycache._constructor_.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apollo/client-react-streaming](./client-react-streaming.md) > [InMemoryCache](./client-react-streaming.inmemorycache.md) > [(constructor)](./client-react-streaming.inmemorycache._constructor_.md) | ||
|
||
## InMemoryCache.(constructor) | ||
|
||
Constructs a new instance of the `InMemoryCache` class | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
constructor(config?: InMemoryCacheConfig | undefined); | ||
``` | ||
|
||
## Parameters | ||
|
||
<table><thead><tr><th> | ||
|
||
Parameter | ||
|
||
|
||
</th><th> | ||
|
||
Type | ||
|
||
|
||
</th><th> | ||
|
||
Description | ||
|
||
|
||
</th></tr></thead> | ||
<tbody><tr><td> | ||
|
||
config | ||
|
||
|
||
</td><td> | ||
|
||
InMemoryCacheConfig \| undefined | ||
|
||
|
||
</td><td> | ||
|
||
_(Optional)_ | ||
|
||
|
||
</td></tr> | ||
</tbody></table> |
11 changes: 11 additions & 0 deletions
11
docs/client-react-streaming.inmemorycache._sourcesymbol_.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apollo/client-react-streaming](./client-react-streaming.md) > [InMemoryCache](./client-react-streaming.inmemorycache.md) > [\[sourceSymbol\]](./client-react-streaming.inmemorycache._sourcesymbol_.md) | ||
|
||
## InMemoryCache.\[sourceSymbol\] property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
[sourceSymbol]: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apollo/client-react-streaming](./client-react-streaming.md) > [TransportedQueryRef](./client-react-streaming.transportedqueryref.md) | ||
|
||
## TransportedQueryRef interface | ||
|
||
A `TransportedQueryRef` is an opaque object accessible via renderProp within `PreloadQuery`<!-- -->. | ||
|
||
A child client component reading the `TransportedQueryRef` via useReadQuery will suspend until the promise resolves. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
interface TransportedQueryRef<TData = unknown, TVariables = unknown> extends QueryRef<TData, TVariables> | ||
``` | ||
**Extends:** QueryRef<TData, TVariables> | ||
## Properties | ||
<table><thead><tr><th> | ||
Property | ||
</th><th> | ||
Modifiers | ||
</th><th> | ||
Type | ||
</th><th> | ||
Description | ||
</th></tr></thead> | ||
<tbody><tr><td> | ||
[toPromise?](./client-react-streaming.transportedqueryref.topromise.md) | ||
</td><td> | ||
</td><td> | ||
() => Promise<[TransportedQueryRef](./client-react-streaming.transportedqueryref.md)<!-- -->> | ||
</td><td> | ||
_(Optional)_ Only available in React Server Components. Will be `undefined` after being passed to Client Components. | ||
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. | ||
</td></tr> | ||
</tbody></table> |
Oops, something went wrong.