Merge pull request #25 from lifeomic/paginated-cache

feat: support updating cache of a infinite query entry

README.md

@@ -455,6 +455,18 @@ cache.updateCache(
 );
 ```
 
+When dealing with a cache entry that was initiated via `useInfiniteAPIQuery` (paginated) prefer using `updateInfiniteCache` which otherwise behaves the same as `updateCache`
+
+```typescript
+const cache = useAPICache();
+
+cache.updateInfiniteCache(
+  'GET /list',
+  { filter: 'some-filter' },
+  (current) => {...},
+);
+```
+
 **Note**: if performing a programmatic update, _no update will occur_ if there is not a cached value.
 
 ## Test Utility API Reference

src/cache.ts

@@ -20,6 +20,7 @@ const createQueryFilterFromSpec = <Endpoints extends RoughEndpoints>(
       }
 
       const payloadsToInvalidate = endpoints[entry.route];
+
       if (!payloadsToInvalidate) {
         return false;
       }
@@ -42,23 +43,21 @@ const createQueryFilterFromSpec = <Endpoints extends RoughEndpoints>(
     }),
 });
 
+export const INFINITE_QUERY_KEY = 'infinite' as const;
+
 export const createCacheUtils = <Endpoints extends RoughEndpoints>(
   client: QueryClient,
   makeQueryKey: <Route extends keyof Endpoints & string>(
     route: Route,
     payload: RequestPayloadOf<Endpoints, Route>,
   ) => InternalQueryKey,
 ): CacheUtils<Endpoints> => {
-  return {
-    invalidateQueries: (spec) => {
-      void client.invalidateQueries(createQueryFilterFromSpec(spec));
-    },
-    resetQueries: (spec) => {
-      void client.resetQueries(createQueryFilterFromSpec(spec));
-    },
-    updateCache: (route, payload, updater) => {
+  const updateCache: (
+    keyPrefix?: typeof INFINITE_QUERY_KEY,
+  ) => CacheUtils<Endpoints>['updateCache'] =
+    (keyPrefix) => (route, payload, updater) => {
       client.setQueryData<Endpoints[typeof route]['Response']>(
-        [makeQueryKey(route, payload)],
+        [keyPrefix, makeQueryKey(route, payload)].filter(Boolean),
         typeof updater !== 'function'
           ? updater
           : (current) => {
@@ -73,6 +72,16 @@ export const createCacheUtils = <Endpoints extends RoughEndpoints>(
               );
             },
       );
+    };
+
+  return {
+    invalidateQueries: (spec) => {
+      void client.invalidateQueries(createQueryFilterFromSpec(spec));
+    },
+    resetQueries: (spec) => {
+      void client.resetQueries(createQueryFilterFromSpec(spec));
     },
+    updateCache: updateCache(),
+    updateInfiniteCache: updateCache(INFINITE_QUERY_KEY),
   };
 };