Add staleWhileRevalidate to next-urql

urql-graphql · Aug 11, 2021 · 64a0ab4 · 64a0ab4
1 parent cce3820
commit 64a0ab4
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/.changeset/new-horses-bow.md b/.changeset/new-horses-bow.md
@@ -0,0 +1,5 @@
+---
+'next-urql': minor
+---
+
+Add new `staleWhileRevalidate` option from the `ssrExchange` addition to `withUrqlClient`'s options. This is useful when Next.js is used in static site generation (SSG) mode.
diff --git a/packages/next-urql/src/types.ts b/packages/next-urql/src/types.ts
@@ -54,4 +54,5 @@ export interface SSRExchange extends Exchange {
 export interface WithUrqlClientOptions {
   ssr?: boolean;
   neverSuspend?: boolean;
+  staleWhileRevalidate?: boolean;
 }
diff --git a/packages/next-urql/src/with-urql-client.ts b/packages/next-urql/src/with-urql-client.ts
@@ -52,7 +52,11 @@ export function withUrqlClient(
 
         if (!ssr || typeof window === 'undefined') {
           // We want to force the cache to hydrate, we do this by setting the isClient flag to true
-          ssr = ssrExchange({ initialState: urqlServerState, isClient: true });
+          ssr = ssrExchange({
+            initialState: urqlServerState,
+            isClient: true,
+            staleWhileRevalidate: options!.staleWhileRevalidate
+          });
         } else if (!version) {
           ssr.restoreData(urqlServerState);
         }