comment update

Shopify · Oct 23, 2024 · 3d6e9b8 · 3d6e9b8
1 parent daa1fac
commit 3d6e9b8
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 6 deletions.
diff --git a/.changeset/serious-pillows-hug.md b/.changeset/serious-pillows-hug.md
@@ -31,7 +31,8 @@ export default {
 +    return withCache.run({
 +      cacheKey: ['my-cms', query],
 +      cacheStrategy: CacheLong(),
-+      shouldCacheResult: (body) => !body?.errors,
++      // Cache if there are no data errors or a specific data that make this result not suited for caching
++      shouldCacheResult: (result) => !result?.errors,
 +    }, async(params) => {
       const response = await fetch('my-cms.com/api', {
         method: 'POST',
@@ -60,7 +61,8 @@ export default {
     },
     {
       cacheStrategy: options.cache ?? CacheLong(),
-      shouldCacheResponse: (body) => !body?.error,
+      // Cache if there are no data errors or a specific data that make this result not suited for caching
+      shouldCacheResponse: (result) => !result?.error,
       cacheKey: ['my-cms', body],
       displayName: 'My CMS query',
     },

diff --git a/packages/hydrogen/src/cache/create-with-cache.example.js b/packages/hydrogen/src/cache/create-with-cache.example.js
@@ -26,7 +26,7 @@ export default {
           // Optionally, specify a cache strategy.
           // Default is CacheShort().
           cacheStrategy: CacheLong(),
-          // Cache if there are no GralhQL errors or a specific result that make this result not suited for caching:
+          // Cache if there are no data errors or a specific data that make this result not suited for caching
           shouldCacheResponse: (result) => !(result?.errors || result?.isLoggedIn),
           // Optionally, add extra information to show
           // in the Subrequest Profiler utility.
@@ -49,7 +49,7 @@ export default {
         // Optionally, specify a cache strategy.
         // Default is CacheShort().
         cacheStrategy: CacheLong(),
-        // Cache if there are no GralhQL errors or a specific result that make this result not suited for caching:
+        // Cache if there are no data errors or a specific data that make this result not suited for caching
         shouldCacheResponse: (result) => !(result?.errors || result?.isLoggedIn),
       }, async (params) => {
         // Run multiple subrequests in parallel, or any other async operations.

diff --git a/packages/hydrogen/src/cache/create-with-cache.example.ts b/packages/hydrogen/src/cache/create-with-cache.example.ts
@@ -44,7 +44,7 @@ export default {
           // Optionally, specify a cache strategy.
           // Default is CacheShort().
           cacheStrategy: CacheLong(),
-          // Cache if there are no GralhQL errors or a specific result that make this result not suited for caching:
+          // Cache if there are no data errors or a specific data that make this result not suited for caching
           shouldCacheResponse: (result) => !(result?.errors || result?.isLoggedIn),
           // Optionally, add extra information to show
           // in the Subrequest Profiler utility.
@@ -67,7 +67,7 @@ export default {
         // Optionally, specify a cache strategy.
         // Default is CacheShort().
         cacheStrategy: CacheLong(),
-        // Cache if there are no GralhQL errors or a specific result that make this result not suited for caching:
+        // Cache if there are no data errors or a specific data that make this result not suited for caching
         shouldCacheResult: (result: MergedResponse) => !(result?.errors || result?.isLoggedIn),
       }, async (params) => {
         // Run multiple subrequests in parallel, or any other async operations.