Usage
We need to create a cache on the server that will hold the external data, and configure the Providers that make the data accessible in the app
In the server rendering
Create a cache instance
Where urls is an array of URLs to prefetch.
This array should be removed to have urls dynamically retrieved in a future version
Wrap the app with SSPRServerProvider
import {SSPRServerProvider, addURL} from 'react-sspr';
const app = <SSPRServerProvider>
<YourApp/>
</SSPRServerProvider>;Add URLs you need cached. This is an async operation and its completion is not required for rendering the app
import {SSPRClientProvider, addURL} from 'react-sspr';
addURL("http://www.test.com");TODO document processURL
In client react
Wrap the app with SSPRClientProvider
<SSPRClientProvider>
<YourApp/>
</SSPRClientProvider>Simply use the useSSPR hook in the components:
const rawCity = useSSPR('https://a-prefetched-url');This is enough to have external data prefetched and filled in the html, for SEO purpose for example.
To avoid having a state change on the client side when the data is refetched during hydration,
add renderStaticSSPR, server-side, to your generated html :
import {renderStaticSSPR} from 'react-sspr';
const ssprData = renderStaticSSPR();
// ...
// in the html template :
<body>
{ssprData}
//...This is going to pass the prefetched data (only the bit that is currently needed, not the whole cache) to the client through the html. No refetch is then needed on the client.
Refreshing the cache
The cache is refreshed when the server restarts.
You can also trigger a refresh using refreshSSPRCache()
Example with an Express server and a route to trigger a refresh :
import {refreshSSPRCache} from 'react-sspr';
app.get('/refetch-external-data-cache', (req, res) => {
refreshSSPRCache();
});