@tanstack/query-async-storage-persister 4.0.0

package/build/umd/index.development.js

@@ -0,0 +1,137 @@
+/**
+ * query-async-storage-persister
+ *
+ * Copyright (c) TanStack
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE.md file in the root directory of this source tree.
+ *
+ * @license MIT
+ */
+(function (global, factory) {
+  typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
+  typeof define === 'function' && define.amd ? define(['exports'], factory) :
+  (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.QueryAsyncStoragePersister = {}));
+})(this, (function (exports) { 'use strict';
+
+  const noop$1 = () => {
+    /* do nothing */
+  };
+
+  function asyncThrottle(func, {
+    interval = 1000,
+    onError = noop$1
+  } = {}) {
+    if (typeof func !== 'function') throw new Error('argument is not function.');
+    let running = false;
+    let lastTime = 0;
+    let timeout;
+    let currentArgs = null;
+
+    const execFunc = async () => {
+      if (currentArgs) {
+        const args = currentArgs;
+        currentArgs = null;
+
+        try {
+          running = true;
+          await func(...args);
+        } catch (error) {
+          onError(error);
+        } finally {
+          lastTime = Date.now(); // this line must after 'func' executed to avoid two 'func' running in concurrent.
+
+          running = false;
+        }
+      }
+    };
+
+    const delayFunc = async () => {
+      clearTimeout(timeout);
+      timeout = setTimeout(() => {
+        if (running) {
+          delayFunc(); // Will come here when 'func' execution time is greater than the interval.
+        } else {
+          execFunc();
+        }
+      }, interval);
+    };
+
+    return (...args) => {
+      currentArgs = args;
+      const tooSoon = Date.now() - lastTime < interval;
+
+      if (running || tooSoon) {
+        delayFunc();
+      } else {
+        execFunc();
+      }
+    };
+  }
+
+  const createAsyncStoragePersister = ({
+    storage,
+    key = "REACT_QUERY_OFFLINE_CACHE",
+    throttleTime = 1000,
+    serialize = JSON.stringify,
+    deserialize = JSON.parse,
+    retry
+  }) => {
+    if (typeof storage !== 'undefined') {
+      const trySave = async persistedClient => {
+        try {
+          await storage.setItem(key, serialize(persistedClient));
+        } catch (error) {
+          return error;
+        }
+      };
+
+      return {
+        persistClient: asyncThrottle(async persistedClient => {
+          let client = persistedClient;
+          let error = await trySave(client);
+          let errorCount = 0;
+
+          while (error && client) {
+            errorCount++;
+            client = await (retry == null ? void 0 : retry({
+              persistedClient: client,
+              error,
+              errorCount
+            }));
+
+            if (client) {
+              error = await trySave(client);
+            }
+          }
+        }, {
+          interval: throttleTime
+        }),
+        restoreClient: async () => {
+          const cacheString = await storage.getItem(key);
+
+          if (!cacheString) {
+            return;
+          }
+
+          return deserialize(cacheString);
+        },
+        removeClient: () => storage.removeItem(key)
+      };
+    }
+
+    return {
+      persistClient: noop,
+      restoreClient: () => Promise.resolve(undefined),
+      removeClient: noop
+    };
+  }; // eslint-disable-next-line @typescript-eslint/no-empty-function
+
+  function noop() {}
+
+  exports.createAsyncStoragePersister = createAsyncStoragePersister;
+
+  Object.defineProperty(exports, '__esModule', { value: true });
+
+}));
+//# sourceMappingURL=index.development.js.map

package/build/umd/index.development.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.development.js","sources":["../../src/asyncThrottle.ts","../../src/index.ts"],"sourcesContent":["export interface AsyncThrottleOptions {\n  interval?: number\n  onError?: (error: unknown) => void\n}\n\nconst noop = () => {\n  /* do nothing */\n}\n\nexport function asyncThrottle<Args extends readonly unknown[]>(\n  func: (...args: Args) => Promise<void>,\n  { interval = 1000, onError = noop }: AsyncThrottleOptions = {},\n) {\n  if (typeof func !== 'function') throw new Error('argument is not function.')\n\n  let running = false\n  let lastTime = 0\n  let timeout: ReturnType<typeof setTimeout>\n  let currentArgs: Args | null = null\n\n  const execFunc = async () => {\n    if (currentArgs) {\n      const args = currentArgs\n      currentArgs = null\n      try {\n        running = true\n        await func(...args)\n      } catch (error) {\n        onError(error)\n      } finally {\n        lastTime = Date.now() // this line must after 'func' executed to avoid two 'func' running in concurrent.\n        running = false\n      }\n    }\n  }\n\n  const delayFunc = async () => {\n    clearTimeout(timeout)\n    timeout = setTimeout(() => {\n      if (running) {\n        delayFunc() // Will come here when 'func' execution time is greater than the interval.\n      } else {\n        execFunc()\n      }\n    }, interval)\n  }\n\n  return (...args: Args) => {\n    currentArgs = args\n\n    const tooSoon = Date.now() - lastTime < interval\n    if (running || tooSoon) {\n      delayFunc()\n    } else {\n      execFunc()\n    }\n  }\n}\n","import {\n  PersistedClient,\n  Persister,\n  Promisable,\n} from '@tanstack/react-query-persist-client'\nimport { asyncThrottle } from './asyncThrottle'\n\ninterface AsyncStorage {\n  getItem: (key: string) => Promise<string | null>\n  setItem: (key: string, value: string) => Promise<void>\n  removeItem: (key: string) => Promise<void>\n}\n\nexport type AsyncPersistRetryer = (props: {\n  persistedClient: PersistedClient\n  error: Error\n  errorCount: number\n}) => Promisable<PersistedClient | undefined>\n\ninterface CreateAsyncStoragePersisterOptions {\n  /** The storage client used for setting and retrieving items from cache.\n   * For SSR pass in `undefined`.\n   */\n  storage: AsyncStorage | undefined\n  /** The key to use when storing the cache */\n  key?: string\n  /** To avoid spamming,\n   * pass a time in ms to throttle saving the cache to disk */\n  throttleTime?: number\n  /**\n   * How to serialize the data to storage.\n   * @default `JSON.stringify`\n   */\n  serialize?: (client: PersistedClient) => string\n  /**\n   * How to deserialize the data from storage.\n   * @default `JSON.parse`\n   */\n  deserialize?: (cachedString: string) => PersistedClient\n\n  retry?: AsyncPersistRetryer\n}\n\nexport const createAsyncStoragePersister = ({\n  storage,\n  key = `REACT_QUERY_OFFLINE_CACHE`,\n  throttleTime = 1000,\n  serialize = JSON.stringify,\n  deserialize = JSON.parse,\n  retry,\n}: CreateAsyncStoragePersisterOptions): Persister => {\n  if (typeof storage !== 'undefined') {\n    const trySave = async (\n      persistedClient: PersistedClient,\n    ): Promise<Error | undefined> => {\n      try {\n        await storage.setItem(key, serialize(persistedClient))\n      } catch (error) {\n        return error as Error\n      }\n    }\n\n    return {\n      persistClient: asyncThrottle(\n        async (persistedClient) => {\n          let client: PersistedClient | undefined = persistedClient\n          let error = await trySave(client)\n          let errorCount = 0\n          while (error && client) {\n            errorCount++\n            client = await retry?.({\n              persistedClient: client,\n              error,\n              errorCount,\n            })\n\n            if (client) {\n              error = await trySave(client)\n            }\n          }\n        },\n        { interval: throttleTime },\n      ),\n      restoreClient: async () => {\n        const cacheString = await storage.getItem(key)\n\n        if (!cacheString) {\n          return\n        }\n\n        return deserialize(cacheString) as PersistedClient\n      },\n      removeClient: () => storage.removeItem(key),\n    }\n  }\n\n  return {\n    persistClient: noop,\n    restoreClient: () => Promise.resolve(undefined),\n    removeClient: noop,\n  }\n}\n\n// eslint-disable-next-line @typescript-eslint/no-empty-function\nfunction noop() {}\n"],"names":["noop","asyncThrottle","func","interval","onError","Error","running","lastTime","timeout","currentArgs","execFunc","args","error","Date","now","delayFunc","clearTimeout","setTimeout","tooSoon","createAsyncStoragePersister","storage","key","throttleTime","serialize","JSON","stringify","deserialize","parse","retry","trySave","persistedClient","setItem","persistClient","client","errorCount","restoreClient","cacheString","getItem","removeClient","removeItem","Promise","resolve","undefined"],"mappings":";;;;;;;;;;;;;;;;EAKA,MAAMA,MAAI,GAAG,MAAM;EACjB;EACD,CAFD,CAAA;;EAIO,SAASC,aAAT,CACLC,IADK,EAEL;EAAEC,EAAAA,QAAQ,GAAG,IAAb;EAAmBC,EAAAA,OAAO,GAAGJ,MAAAA;EAA7B,CAAA,GAA4D,EAFvD,EAGL;IACA,IAAI,OAAOE,IAAP,KAAgB,UAApB,EAAgC,MAAM,IAAIG,KAAJ,CAAU,2BAAV,CAAN,CAAA;IAEhC,IAAIC,OAAO,GAAG,KAAd,CAAA;IACA,IAAIC,QAAQ,GAAG,CAAf,CAAA;EACA,EAAA,IAAIC,OAAJ,CAAA;IACA,IAAIC,WAAwB,GAAG,IAA/B,CAAA;;IAEA,MAAMC,QAAQ,GAAG,YAAY;EAC3B,IAAA,IAAID,WAAJ,EAAiB;QACf,MAAME,IAAI,GAAGF,WAAb,CAAA;EACAA,MAAAA,WAAW,GAAG,IAAd,CAAA;;QACA,IAAI;EACFH,QAAAA,OAAO,GAAG,IAAV,CAAA;EACA,QAAA,MAAMJ,IAAI,CAAC,GAAGS,IAAJ,CAAV,CAAA;SAFF,CAGE,OAAOC,KAAP,EAAc;UACdR,OAAO,CAACQ,KAAD,CAAP,CAAA;EACD,OALD,SAKU;EACRL,QAAAA,QAAQ,GAAGM,IAAI,CAACC,GAAL,EAAX,CADQ;;EAERR,QAAAA,OAAO,GAAG,KAAV,CAAA;EACD,OAAA;EACF,KAAA;KAbH,CAAA;;IAgBA,MAAMS,SAAS,GAAG,YAAY;MAC5BC,YAAY,CAACR,OAAD,CAAZ,CAAA;MACAA,OAAO,GAAGS,UAAU,CAAC,MAAM;EACzB,MAAA,IAAIX,OAAJ,EAAa;EACXS,QAAAA,SAAS,GADE;EAEZ,OAFD,MAEO;UACLL,QAAQ,EAAA,CAAA;EACT,OAAA;OALiB,EAMjBP,QANiB,CAApB,CAAA;KAFF,CAAA;;IAWA,OAAO,CAAC,GAAGQ,IAAJ,KAAmB;EACxBF,IAAAA,WAAW,GAAGE,IAAd,CAAA;MAEA,MAAMO,OAAO,GAAGL,IAAI,CAACC,GAAL,EAAaP,GAAAA,QAAb,GAAwBJ,QAAxC,CAAA;;MACA,IAAIG,OAAO,IAAIY,OAAf,EAAwB;QACtBH,SAAS,EAAA,CAAA;EACV,KAFD,MAEO;QACLL,QAAQ,EAAA,CAAA;EACT,KAAA;KARH,CAAA;EAUD;;ACdM,QAAMS,2BAA2B,GAAG,CAAC;IAC1CC,OAD0C;EAE1CC,EAAAA,GAAG,GAFuC,2BAAA;EAG1CC,EAAAA,YAAY,GAAG,IAH2B;IAI1CC,SAAS,GAAGC,IAAI,CAACC,SAJyB;IAK1CC,WAAW,GAAGF,IAAI,CAACG,KALuB;EAM1CC,EAAAA,KAAAA;EAN0C,CAAD,KAOU;EACnD,EAAA,IAAI,OAAOR,OAAP,KAAmB,WAAvB,EAAoC;EAClC,IAAA,MAAMS,OAAO,GAAG,MACdC,eADc,IAEiB;QAC/B,IAAI;UACF,MAAMV,OAAO,CAACW,OAAR,CAAgBV,GAAhB,EAAqBE,SAAS,CAACO,eAAD,CAA9B,CAAN,CAAA;SADF,CAEE,OAAOlB,KAAP,EAAc;EACd,QAAA,OAAOA,KAAP,CAAA;EACD,OAAA;OAPH,CAAA;;MAUA,OAAO;EACLoB,MAAAA,aAAa,EAAE/B,aAAa,CAC1B,MAAO6B,eAAP,IAA2B;UACzB,IAAIG,MAAmC,GAAGH,eAA1C,CAAA;EACA,QAAA,IAAIlB,KAAK,GAAG,MAAMiB,OAAO,CAACI,MAAD,CAAzB,CAAA;UACA,IAAIC,UAAU,GAAG,CAAjB,CAAA;;UACA,OAAOtB,KAAK,IAAIqB,MAAhB,EAAwB;YACtBC,UAAU,EAAA,CAAA;EACVD,UAAAA,MAAM,GAAG,OAAML,KAAN,IAAA,IAAA,GAAA,KAAA,CAAA,GAAMA,KAAK,CAAG;EACrBE,YAAAA,eAAe,EAAEG,MADI;cAErBrB,KAFqB;EAGrBsB,YAAAA,UAAAA;EAHqB,WAAH,CAAX,CAAT,CAAA;;EAMA,UAAA,IAAID,MAAJ,EAAY;EACVrB,YAAAA,KAAK,GAAG,MAAMiB,OAAO,CAACI,MAAD,CAArB,CAAA;EACD,WAAA;EACF,SAAA;EACF,OAjByB,EAkB1B;EAAE9B,QAAAA,QAAQ,EAAEmB,YAAAA;EAAZ,OAlB0B,CADvB;EAqBLa,MAAAA,aAAa,EAAE,YAAY;UACzB,MAAMC,WAAW,GAAG,MAAMhB,OAAO,CAACiB,OAAR,CAAgBhB,GAAhB,CAA1B,CAAA;;UAEA,IAAI,CAACe,WAAL,EAAkB;EAChB,UAAA,OAAA;EACD,SAAA;;UAED,OAAOV,WAAW,CAACU,WAAD,CAAlB,CAAA;SA5BG;EA8BLE,MAAAA,YAAY,EAAE,MAAMlB,OAAO,CAACmB,UAAR,CAAmBlB,GAAnB,CAAA;OA9BtB,CAAA;EAgCD,GAAA;;IAED,OAAO;EACLW,IAAAA,aAAa,EAAEhC,IADV;EAELmC,IAAAA,aAAa,EAAE,MAAMK,OAAO,CAACC,OAAR,CAAgBC,SAAhB,CAFhB;EAGLJ,IAAAA,YAAY,EAAEtC,IAAAA;KAHhB,CAAA;EAKD;;EAGD,SAASA,IAAT,GAAgB;;;;;;;;;;"}

package/build/umd/index.production.js

@@ -0,0 +1,12 @@
+/**
+ * query-async-storage-persister
+ *
+ * Copyright (c) TanStack
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE.md file in the root directory of this source tree.
+ *
+ * @license MIT
+ */
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).QueryAsyncStoragePersister={})}(this,(function(e){"use strict";const t=()=>{};function r(e,{interval:r=1e3,onError:n=t}={}){if("function"!=typeof e)throw new Error("argument is not function.");let i,o=!1,s=0,a=null;const l=async()=>{if(a){const t=a;a=null;try{o=!0,await e(...t)}catch(e){n(e)}finally{s=Date.now(),o=!1}}},c=async()=>{clearTimeout(i),i=setTimeout((()=>{o?c():l()}),r)};return(...e)=>{a=e;const t=Date.now()-s<r;o||t?c():l()}}function n(){}e.createAsyncStoragePersister=({storage:e,key:t="REACT_QUERY_OFFLINE_CACHE",throttleTime:i=1e3,serialize:o=JSON.stringify,deserialize:s=JSON.parse,retry:a})=>{if(void 0!==e){const n=async r=>{try{await e.setItem(t,o(r))}catch(e){return e}};return{persistClient:r((async e=>{let t=e,r=await n(t),i=0;for(;r&&t;)i++,t=await(null==a?void 0:a({persistedClient:t,error:r,errorCount:i})),t&&(r=await n(t))}),{interval:i}),restoreClient:async()=>{const r=await e.getItem(t);if(r)return s(r)},removeClient:()=>e.removeItem(t)}}return{persistClient:n,restoreClient:()=>Promise.resolve(void 0),removeClient:n}},Object.defineProperty(e,"__esModule",{value:!0})}));
+//# sourceMappingURL=index.production.js.map

package/build/umd/index.production.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.production.js","sources":["../../src/asyncThrottle.ts","../../src/index.ts"],"sourcesContent":["export interface AsyncThrottleOptions {\n  interval?: number\n  onError?: (error: unknown) => void\n}\n\nconst noop = () => {\n  /* do nothing */\n}\n\nexport function asyncThrottle<Args extends readonly unknown[]>(\n  func: (...args: Args) => Promise<void>,\n  { interval = 1000, onError = noop }: AsyncThrottleOptions = {},\n) {\n  if (typeof func !== 'function') throw new Error('argument is not function.')\n\n  let running = false\n  let lastTime = 0\n  let timeout: ReturnType<typeof setTimeout>\n  let currentArgs: Args | null = null\n\n  const execFunc = async () => {\n    if (currentArgs) {\n      const args = currentArgs\n      currentArgs = null\n      try {\n        running = true\n        await func(...args)\n      } catch (error) {\n        onError(error)\n      } finally {\n        lastTime = Date.now() // this line must after 'func' executed to avoid two 'func' running in concurrent.\n        running = false\n      }\n    }\n  }\n\n  const delayFunc = async () => {\n    clearTimeout(timeout)\n    timeout = setTimeout(() => {\n      if (running) {\n        delayFunc() // Will come here when 'func' execution time is greater than the interval.\n      } else {\n        execFunc()\n      }\n    }, interval)\n  }\n\n  return (...args: Args) => {\n    currentArgs = args\n\n    const tooSoon = Date.now() - lastTime < interval\n    if (running || tooSoon) {\n      delayFunc()\n    } else {\n      execFunc()\n    }\n  }\n}\n","import {\n  PersistedClient,\n  Persister,\n  Promisable,\n} from '@tanstack/react-query-persist-client'\nimport { asyncThrottle } from './asyncThrottle'\n\ninterface AsyncStorage {\n  getItem: (key: string) => Promise<string | null>\n  setItem: (key: string, value: string) => Promise<void>\n  removeItem: (key: string) => Promise<void>\n}\n\nexport type AsyncPersistRetryer = (props: {\n  persistedClient: PersistedClient\n  error: Error\n  errorCount: number\n}) => Promisable<PersistedClient | undefined>\n\ninterface CreateAsyncStoragePersisterOptions {\n  /** The storage client used for setting and retrieving items from cache.\n   * For SSR pass in `undefined`.\n   */\n  storage: AsyncStorage | undefined\n  /** The key to use when storing the cache */\n  key?: string\n  /** To avoid spamming,\n   * pass a time in ms to throttle saving the cache to disk */\n  throttleTime?: number\n  /**\n   * How to serialize the data to storage.\n   * @default `JSON.stringify`\n   */\n  serialize?: (client: PersistedClient) => string\n  /**\n   * How to deserialize the data from storage.\n   * @default `JSON.parse`\n   */\n  deserialize?: (cachedString: string) => PersistedClient\n\n  retry?: AsyncPersistRetryer\n}\n\nexport const createAsyncStoragePersister = ({\n  storage,\n  key = `REACT_QUERY_OFFLINE_CACHE`,\n  throttleTime = 1000,\n  serialize = JSON.stringify,\n  deserialize = JSON.parse,\n  retry,\n}: CreateAsyncStoragePersisterOptions): Persister => {\n  if (typeof storage !== 'undefined') {\n    const trySave = async (\n      persistedClient: PersistedClient,\n    ): Promise<Error | undefined> => {\n      try {\n        await storage.setItem(key, serialize(persistedClient))\n      } catch (error) {\n        return error as Error\n      }\n    }\n\n    return {\n      persistClient: asyncThrottle(\n        async (persistedClient) => {\n          let client: PersistedClient | undefined = persistedClient\n          let error = await trySave(client)\n          let errorCount = 0\n          while (error && client) {\n            errorCount++\n            client = await retry?.({\n              persistedClient: client,\n              error,\n              errorCount,\n            })\n\n            if (client) {\n              error = await trySave(client)\n            }\n          }\n        },\n        { interval: throttleTime },\n      ),\n      restoreClient: async () => {\n        const cacheString = await storage.getItem(key)\n\n        if (!cacheString) {\n          return\n        }\n\n        return deserialize(cacheString) as PersistedClient\n      },\n      removeClient: () => storage.removeItem(key),\n    }\n  }\n\n  return {\n    persistClient: noop,\n    restoreClient: () => Promise.resolve(undefined),\n    removeClient: noop,\n  }\n}\n\n// eslint-disable-next-line @typescript-eslint/no-empty-function\nfunction noop() {}\n"],"names":["noop","asyncThrottle","func","interval","onError","Error","timeout","running","lastTime","currentArgs","execFunc","async","args","error","Date","now","delayFunc","clearTimeout","setTimeout","tooSoon","storage","key","throttleTime","serialize","JSON","stringify","deserialize","parse","retry","trySave","setItem","persistedClient","persistClient","client","errorCount","restoreClient","cacheString","getItem","removeClient","removeItem","Promise","resolve","undefined"],"mappings":";;;;;;;;;;kQAKA,MAAMA,EAAO,OAIN,SAASC,EACdC,GACAC,SAAEA,EAAW,IAAbC,QAAmBA,EAAUJ,GAA+B,IAE5D,GAAoB,mBAATE,EAAqB,MAAM,IAAIG,MAAM,6BAEhD,IAEIC,EAFAC,GAAU,EACVC,EAAW,EAEXC,EAA2B,KAE/B,MAAMC,EAAWC,UACf,GAAIF,EAAa,CACf,MAAMG,EAAOH,EACbA,EAAc,KACd,IACEF,GAAU,QACJL,KAAQU,GACd,MAAOC,GACPT,EAAQS,GACA,QACRL,EAAWM,KAAKC,MAChBR,GAAU,KAKVS,EAAYL,UAChBM,aAAaX,GACbA,EAAUY,YAAW,KACfX,EACFS,IAEAN,MAEDP,IAGL,MAAO,IAAIS,KACTH,EAAcG,EAEd,MAAMO,EAAUL,KAAKC,MAAQP,EAAWL,EACpCI,GAAWY,EACbH,IAEAN,KCkDN,SAASV,mCA7DkC,EACzCoB,UACAC,MAF0C,4BAG1CC,eAAe,IACfC,YAAYC,KAAKC,UACjBC,cAAcF,KAAKG,MACnBC,YAEA,QAAuB,IAAZR,EAAyB,CAClC,MAAMS,EAAUlB,UAGd,UACQS,EAAQU,QAAQT,EAAKE,EAAUQ,IACrC,MAAOlB,GACP,OAAOA,IAIX,MAAO,CACLmB,cAAe/B,GACbU,UACE,IAAIsB,EAAsCF,EACtClB,QAAcgB,EAAQI,GACtBC,EAAa,EACjB,KAAOrB,GAASoB,GACdC,IACAD,QAAS,MAAML,OAAN,EAAMA,EAAQ,CACrBG,gBAAiBE,EACjBpB,QACAqB,gBAGED,IACFpB,QAAcgB,EAAQI,MAI5B,CAAE9B,SAAUmB,IAEda,cAAexB,UACb,MAAMyB,QAAoBhB,EAAQiB,QAAQhB,GAE1C,GAAKe,EAIL,OAAOV,EAAYU,IAErBE,aAAc,IAAMlB,EAAQmB,WAAWlB,IAI3C,MAAO,CACLW,cAAehC,EACfmC,cAAe,IAAMK,QAAQC,aAAQC,GACrCJ,aAActC"}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@tanstack/query-async-storage-persister",
+  "version": "4.0.0",
+  "description": "TODO",
+  "author": "tannerlinsley",
+  "license": "MIT",
+  "repository": "tanstack/query",
+  "homepage": "https://tanstack.com/query",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/tannerlinsley"
+  },
+  "module": "build/esm/index.js",
+  "main": "build/cjs/index.js",
+  "browser": "build/umd/index.production.js",
+  "types": "build/types/packages/query-async-storage-persister/src/index.d.ts",
+  "files": [
+    "build",
+    "src"
+  ],
+  "scripts": {
+    "test:eslint": "../../node_modules/.bin/eslint --ext .ts,.tsx ./src",
+    "compile": "../../node_modules/.bin/tsc -p tsconfig.json --noEmit --emitDeclarationOnly false"
+  }
+}

package/src/__tests__/asyncThrottle.test.ts

@@ -0,0 +1,127 @@
+import { asyncThrottle } from '../asyncThrottle'
+import { sleep as delay } from '../../../../tests/utils'
+
+describe('asyncThrottle', () => {
+  test('basic', async () => {
+    const interval = 10
+    const execTimeStamps: number[] = []
+    const mockFunc = jest.fn(
+      async (id: number, complete?: (value?: unknown) => void) => {
+        await delay(1)
+        execTimeStamps.push(Date.now())
+        if (complete) {
+          complete(id)
+        }
+      },
+    )
+    const testFunc = asyncThrottle(mockFunc, { interval })
+
+    testFunc(1)
+    await delay(1)
+    testFunc(2)
+    await delay(1)
+    await new Promise((resolve) => testFunc(3, resolve))
+
+    expect(mockFunc).toBeCalledTimes(2)
+    expect(mockFunc.mock.calls[1]?.[0]).toBe(3)
+    expect(execTimeStamps.length).toBe(2)
+    expect(execTimeStamps[1]! - execTimeStamps[0]!).toBeGreaterThanOrEqual(
+      interval,
+    )
+  })
+
+  test('Bug #3331 case 1: Special timing', async () => {
+    const interval = 1000
+    const execTimeStamps: number[] = []
+    const mockFunc = jest.fn(
+      async (id: number, complete?: (value?: unknown) => void) => {
+        await delay(30)
+        execTimeStamps.push(Date.now())
+        if (complete) {
+          complete(id)
+        }
+      },
+    )
+    const testFunc = asyncThrottle(mockFunc, { interval })
+
+    testFunc(1)
+    testFunc(2)
+    await delay(35)
+    testFunc(3)
+    await delay(35)
+    await new Promise((resolve) => testFunc(4, resolve))
+
+    expect(mockFunc).toBeCalledTimes(2)
+    expect(mockFunc.mock.calls[1]?.[0]).toBe(4)
+    expect(execTimeStamps.length).toBe(2)
+    expect(execTimeStamps[1]! - execTimeStamps[0]!).toBeGreaterThanOrEqual(
+      interval,
+    )
+  })
+
+  test('Bug #3331 case 2: "func" execution time is greater than the interval.', async () => {
+    const interval = 1000
+    const execTimeStamps: number[] = []
+    const mockFunc = jest.fn(
+      async (id: number, complete?: (value?: unknown) => void) => {
+        await delay(interval + 10)
+        execTimeStamps.push(Date.now())
+        if (complete) {
+          complete(id)
+        }
+      },
+    )
+    const testFunc = asyncThrottle(mockFunc, { interval })
+
+    testFunc(1)
+    testFunc(2)
+    await new Promise((resolve) => testFunc(3, resolve))
+
+    expect(mockFunc).toBeCalledTimes(2)
+    expect(mockFunc.mock.calls[1]?.[0]).toBe(3)
+    expect(execTimeStamps.length).toBe(2)
+    expect(execTimeStamps[1]! - execTimeStamps[0]!).toBeGreaterThanOrEqual(
+      interval,
+    )
+  })
+
+  test('"func" throw error not break next invoke', async () => {
+    const mockFunc = jest.fn(
+      async (id: number, complete?: (value?: unknown) => void) => {
+        if (id === 1) throw new Error('error')
+        await delay(1)
+        if (complete) {
+          complete(id)
+        }
+      },
+    )
+    const testFunc = asyncThrottle(mockFunc, { interval: 10 })
+
+    testFunc(1)
+    await delay(1)
+    await new Promise((resolve) => testFunc(2, resolve))
+
+    expect(mockFunc).toBeCalledTimes(2)
+    expect(mockFunc.mock.calls[1]?.[0]).toBe(2)
+  })
+
+  test('"onError" should be called when "func" throw error', (done) => {
+    const err = new Error('error')
+    const handleError = (e: unknown) => {
+      expect(e).toBe(err)
+      done()
+    }
+
+    const testFunc = asyncThrottle(
+      () => {
+        throw err
+      },
+      { onError: handleError },
+    )
+    testFunc()
+  })
+
+  test('should throw error when "func" is not a function', () => {
+    expect(() => asyncThrottle(1 as any)).toThrowError()
+  })
+})

package/src/asyncThrottle.ts

@@ -0,0 +1,58 @@
+export interface AsyncThrottleOptions {
+  interval?: number
+  onError?: (error: unknown) => void
+}
+
+const noop = () => {
+  /* do nothing */
+}
+
+export function asyncThrottle<Args extends readonly unknown[]>(
+  func: (...args: Args) => Promise<void>,
+  { interval = 1000, onError = noop }: AsyncThrottleOptions = {},
+) {
+  if (typeof func !== 'function') throw new Error('argument is not function.')
+
+  let running = false
+  let lastTime = 0
+  let timeout: ReturnType<typeof setTimeout>
+  let currentArgs: Args | null = null
+
+  const execFunc = async () => {
+    if (currentArgs) {
+      const args = currentArgs
+      currentArgs = null
+      try {
+        running = true
+        await func(...args)
+      } catch (error) {
+        onError(error)
+      } finally {
+        lastTime = Date.now() // this line must after 'func' executed to avoid two 'func' running in concurrent.
+        running = false
+      }
+    }
+  }
+
+  const delayFunc = async () => {
+    clearTimeout(timeout)
+    timeout = setTimeout(() => {
+      if (running) {
+        delayFunc() // Will come here when 'func' execution time is greater than the interval.
+      } else {
+        execFunc()
+      }
+    }, interval)
+  }
+
+  return (...args: Args) => {
+    currentArgs = args
+
+    const tooSoon = Date.now() - lastTime < interval
+    if (running || tooSoon) {
+      delayFunc()
+    } else {
+      execFunc()
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,105 @@
+import {
+  PersistedClient,
+  Persister,
+  Promisable,
+} from '@tanstack/react-query-persist-client'
+import { asyncThrottle } from './asyncThrottle'
+
+interface AsyncStorage {
+  getItem: (key: string) => Promise<string | null>
+  setItem: (key: string, value: string) => Promise<void>
+  removeItem: (key: string) => Promise<void>
+}
+
+export type AsyncPersistRetryer = (props: {
+  persistedClient: PersistedClient
+  error: Error
+  errorCount: number
+}) => Promisable<PersistedClient | undefined>
+
+interface CreateAsyncStoragePersisterOptions {
+  /** The storage client used for setting and retrieving items from cache.
+   * For SSR pass in `undefined`.
+   */
+  storage: AsyncStorage | undefined
+  /** The key to use when storing the cache */
+  key?: string
+  /** To avoid spamming,
+   * pass a time in ms to throttle saving the cache to disk */
+  throttleTime?: number
+  /**
+   * How to serialize the data to storage.
+   * @default `JSON.stringify`
+   */
+  serialize?: (client: PersistedClient) => string
+  /**
+   * How to deserialize the data from storage.
+   * @default `JSON.parse`
+   */
+  deserialize?: (cachedString: string) => PersistedClient
+
+  retry?: AsyncPersistRetryer
+}
+
+export const createAsyncStoragePersister = ({
+  storage,
+  key = `REACT_QUERY_OFFLINE_CACHE`,
+  throttleTime = 1000,
+  serialize = JSON.stringify,
+  deserialize = JSON.parse,
+  retry,
+}: CreateAsyncStoragePersisterOptions): Persister => {
+  if (typeof storage !== 'undefined') {
+    const trySave = async (
+      persistedClient: PersistedClient,
+    ): Promise<Error | undefined> => {
+      try {
+        await storage.setItem(key, serialize(persistedClient))
+      } catch (error) {
+        return error as Error
+      }
+    }
+
+    return {
+      persistClient: asyncThrottle(
+        async (persistedClient) => {
+          let client: PersistedClient | undefined = persistedClient
+          let error = await trySave(client)
+          let errorCount = 0
+          while (error && client) {
+            errorCount++
+            client = await retry?.({
+              persistedClient: client,
+              error,
+              errorCount,
+            })
+
+            if (client) {
+              error = await trySave(client)
+            }
+          }
+        },
+        { interval: throttleTime },
+      ),
+      restoreClient: async () => {
+        const cacheString = await storage.getItem(key)
+
+        if (!cacheString) {
+          return
+        }
+
+        return deserialize(cacheString) as PersistedClient
+      },
+      removeClient: () => storage.removeItem(key),
+    }
+  }
+
+  return {
+    persistClient: noop,
+    restoreClient: () => Promise.resolve(undefined),
+    removeClient: noop,
+  }
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-function
+function noop() {}