@tanstack/query-async-storage-persister 5.0.0-beta.9 → 5.0.0-rc.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/legacy/asyncThrottle.cjs.map +1 -1
- package/build/legacy/asyncThrottle.d.cts +1 -1
- package/build/legacy/asyncThrottle.d.ts +1 -1
- package/build/legacy/asyncThrottle.js.map +1 -1
- package/build/legacy/index.cjs.map +1 -1
- package/build/legacy/index.d.cts +1 -6
- package/build/legacy/index.d.ts +1 -6
- package/build/legacy/index.js.map +1 -1
- package/build/modern/asyncThrottle.cjs.map +1 -1
- package/build/modern/asyncThrottle.d.cts +1 -1
- package/build/modern/asyncThrottle.d.ts +1 -1
- package/build/modern/asyncThrottle.js.map +1 -1
- package/build/modern/index.cjs.map +1 -1
- package/build/modern/index.d.cts +1 -6
- package/build/modern/index.d.ts +1 -6
- package/build/modern/index.js.map +1 -1
- package/package.json +7 -3
- package/src/__tests__/asyncThrottle.test.ts +3 -3
- package/src/asyncThrottle.ts +1 -1
- package/src/index.ts +1 -6
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/asyncThrottle.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
|
|
1
|
+
{"version":3,"sources":["../../src/asyncThrottle.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 ReadonlyArray<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"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAKA,IAAM,OAAO,MAAM;AAEnB;AAEO,SAAS,cACd,MACA,EAAE,WAAW,KAAM,UAAU,KAAK,IAA0B,CAAC,GAC7D;AACA,MAAI,OAAO,SAAS;AAAY,UAAM,IAAI,MAAM,2BAA2B;AAE3E,MAAI,UAAU;AACd,MAAI,WAAW;AACf,MAAI;AACJ,MAAI,cAA2B;AAE/B,QAAM,WAAW,YAAY;AAC3B,QAAI,aAAa;AACf,YAAM,OAAO;AACb,oBAAc;AACd,UAAI;AACF,kBAAU;AACV,cAAM,KAAK,GAAG,IAAI;AAAA,MACpB,SAAS,OAAO;AACd,gBAAQ,KAAK;AAAA,MACf,UAAE;AACA,mBAAW,KAAK,IAAI;AACpB,kBAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,QAAM,YAAY,YAAY;AAC5B,iBAAa,OAAO;AACpB,cAAU,WAAW,MAAM;AACzB,UAAI,SAAS;AACX,kBAAU;AAAA,MACZ,OAAO;AACL,iBAAS;AAAA,MACX;AAAA,IACF,GAAG,QAAQ;AAAA,EACb;AAEA,SAAO,IAAI,SAAe;AACxB,kBAAc;AAEd,UAAM,UAAU,KAAK,IAAI,IAAI,WAAW;AACxC,QAAI,WAAW,SAAS;AACtB,gBAAU;AAAA,IACZ,OAAO;AACL,eAAS;AAAA,IACX;AAAA,EACF;AACF;","names":[]}
|
|
@@ -2,6 +2,6 @@ interface AsyncThrottleOptions {
|
|
|
2
2
|
interval?: number;
|
|
3
3
|
onError?: (error: unknown) => void;
|
|
4
4
|
}
|
|
5
|
-
declare function asyncThrottle<Args extends
|
|
5
|
+
declare function asyncThrottle<Args extends ReadonlyArray<unknown>>(func: (...args: Args) => Promise<void>, { interval, onError }?: AsyncThrottleOptions): (...args: Args) => void;
|
|
6
6
|
|
|
7
7
|
export { AsyncThrottleOptions, asyncThrottle };
|
|
@@ -2,6 +2,6 @@ interface AsyncThrottleOptions {
|
|
|
2
2
|
interval?: number;
|
|
3
3
|
onError?: (error: unknown) => void;
|
|
4
4
|
}
|
|
5
|
-
declare function asyncThrottle<Args extends
|
|
5
|
+
declare function asyncThrottle<Args extends ReadonlyArray<unknown>>(func: (...args: Args) => Promise<void>, { interval, onError }?: AsyncThrottleOptions): (...args: Args) => void;
|
|
6
6
|
|
|
7
7
|
export { AsyncThrottleOptions, asyncThrottle };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/asyncThrottle.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
|
|
1
|
+
{"version":3,"sources":["../../src/asyncThrottle.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 ReadonlyArray<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"],"mappings":";AAKA,IAAM,OAAO,MAAM;AAEnB;AAEO,SAAS,cACd,MACA,EAAE,WAAW,KAAM,UAAU,KAAK,IAA0B,CAAC,GAC7D;AACA,MAAI,OAAO,SAAS;AAAY,UAAM,IAAI,MAAM,2BAA2B;AAE3E,MAAI,UAAU;AACd,MAAI,WAAW;AACf,MAAI;AACJ,MAAI,cAA2B;AAE/B,QAAM,WAAW,YAAY;AAC3B,QAAI,aAAa;AACf,YAAM,OAAO;AACb,oBAAc;AACd,UAAI;AACF,kBAAU;AACV,cAAM,KAAK,GAAG,IAAI;AAAA,MACpB,SAAS,OAAO;AACd,gBAAQ,KAAK;AAAA,MACf,UAAE;AACA,mBAAW,KAAK,IAAI;AACpB,kBAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,QAAM,YAAY,YAAY;AAC5B,iBAAa,OAAO;AACpB,cAAU,WAAW,MAAM;AACzB,UAAI,SAAS;AACX,kBAAU;AAAA,MACZ,OAAO;AACL,iBAAS;AAAA,MACX;AAAA,IACF,GAAG,QAAQ;AAAA,EACb;AAEA,SAAO,IAAI,SAAe;AACxB,kBAAc;AAEd,UAAM,UAAU,KAAK,IAAI,IAAI,WAAW;AACxC,QAAI,WAAW,SAAS;AACtB,gBAAU;AAAA,IACZ,OAAO;AACL,eAAS;AAAA,IACX;AAAA,EACF;AACF;","names":[]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import { asyncThrottle } from './asyncThrottle'\nimport type {\n PersistedClient,\n Persister,\n Promisable,\n} from '@tanstack/query-persist-client-core'\n\
|
|
1
|
+
{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import { asyncThrottle } from './asyncThrottle'\nimport type {\n AsyncStorage,\n PersistedClient,\n Persister,\n Promisable,\n} from '@tanstack/query-persist-client-core'\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`. Note that window.localStorage can be\n * `null` in Android WebViews depending on how they are configured.\n */\n storage: AsyncStorage | undefined | null\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 (storage) {\n const trySave = async (\n persistedClient: PersistedClient,\n ): Promise<Error | undefined> => {\n try {\n await storage.setItem(key, serialize(persistedClient))\n return\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)\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"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,2BAA8B;AAuCvB,IAAM,8BAA8B,CAAC;AAAA,EAC1C;AAAA,EACA,MAAM;AAAA,EACN,eAAe;AAAA,EACf,YAAY,KAAK;AAAA,EACjB,cAAc,KAAK;AAAA,EACnB;AACF,MAAqD;AACnD,MAAI,SAAS;AACX,UAAM,UAAU,OACd,oBAC+B;AAC/B,UAAI;AACF,cAAM,QAAQ,QAAQ,KAAK,UAAU,eAAe,CAAC;AACrD;AAAA,MACF,SAAS,OAAO;AACd,eAAO;AAAA,MACT;AAAA,IACF;AAEA,WAAO;AAAA,MACL,mBAAe;AAAA,QACb,OAAO,oBAAoB;AACzB,cAAI,SAAsC;AAC1C,cAAI,QAAQ,MAAM,QAAQ,MAAM;AAChC,cAAI,aAAa;AACjB,iBAAO,SAAS,QAAQ;AACtB;AACA,qBAAS,OAAM,+BAAQ;AAAA,cACrB,iBAAiB;AAAA,cACjB;AAAA,cACA;AAAA,YACF;AAEA,gBAAI,QAAQ;AACV,sBAAQ,MAAM,QAAQ,MAAM;AAAA,YAC9B;AAAA,UACF;AAAA,QACF;AAAA,QACA,EAAE,UAAU,aAAa;AAAA,MAC3B;AAAA,MACA,eAAe,YAAY;AACzB,cAAM,cAAc,MAAM,QAAQ,QAAQ,GAAG;AAE7C,YAAI,CAAC,aAAa;AAChB;AAAA,QACF;AAEA,eAAO,YAAY,WAAW;AAAA,MAChC;AAAA,MACA,cAAc,MAAM,QAAQ,WAAW,GAAG;AAAA,IAC5C;AAAA,EACF;AAEA,SAAO;AAAA,IACL,eAAe;AAAA,IACf,eAAe,MAAM,QAAQ,QAAQ,MAAS;AAAA,IAC9C,cAAc;AAAA,EAChB;AACF;AAGA,SAAS,OAAO;AAAC;","names":[]}
|
package/build/legacy/index.d.cts
CHANGED
|
@@ -1,10 +1,5 @@
|
|
|
1
|
-
import { PersistedClient, Promisable, Persister } from '@tanstack/query-persist-client-core';
|
|
1
|
+
import { PersistedClient, Promisable, Persister, AsyncStorage } from '@tanstack/query-persist-client-core';
|
|
2
2
|
|
|
3
|
-
interface AsyncStorage {
|
|
4
|
-
getItem: (key: string) => Promise<string | null>;
|
|
5
|
-
setItem: (key: string, value: string) => Promise<unknown>;
|
|
6
|
-
removeItem: (key: string) => Promise<void>;
|
|
7
|
-
}
|
|
8
3
|
type AsyncPersistRetryer = (props: {
|
|
9
4
|
persistedClient: PersistedClient;
|
|
10
5
|
error: Error;
|
package/build/legacy/index.d.ts
CHANGED
|
@@ -1,10 +1,5 @@
|
|
|
1
|
-
import { PersistedClient, Promisable, Persister } from '@tanstack/query-persist-client-core';
|
|
1
|
+
import { PersistedClient, Promisable, Persister, AsyncStorage } from '@tanstack/query-persist-client-core';
|
|
2
2
|
|
|
3
|
-
interface AsyncStorage {
|
|
4
|
-
getItem: (key: string) => Promise<string | null>;
|
|
5
|
-
setItem: (key: string, value: string) => Promise<unknown>;
|
|
6
|
-
removeItem: (key: string) => Promise<void>;
|
|
7
|
-
}
|
|
8
3
|
type AsyncPersistRetryer = (props: {
|
|
9
4
|
persistedClient: PersistedClient;
|
|
10
5
|
error: Error;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import { asyncThrottle } from './asyncThrottle'\nimport type {\n PersistedClient,\n Persister,\n Promisable,\n} from '@tanstack/query-persist-client-core'\n\
|
|
1
|
+
{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import { asyncThrottle } from './asyncThrottle'\nimport type {\n AsyncStorage,\n PersistedClient,\n Persister,\n Promisable,\n} from '@tanstack/query-persist-client-core'\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`. Note that window.localStorage can be\n * `null` in Android WebViews depending on how they are configured.\n */\n storage: AsyncStorage | undefined | null\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 (storage) {\n const trySave = async (\n persistedClient: PersistedClient,\n ): Promise<Error | undefined> => {\n try {\n await storage.setItem(key, serialize(persistedClient))\n return\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)\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"],"mappings":";AAAA,SAAS,qBAAqB;AAuCvB,IAAM,8BAA8B,CAAC;AAAA,EAC1C;AAAA,EACA,MAAM;AAAA,EACN,eAAe;AAAA,EACf,YAAY,KAAK;AAAA,EACjB,cAAc,KAAK;AAAA,EACnB;AACF,MAAqD;AACnD,MAAI,SAAS;AACX,UAAM,UAAU,OACd,oBAC+B;AAC/B,UAAI;AACF,cAAM,QAAQ,QAAQ,KAAK,UAAU,eAAe,CAAC;AACrD;AAAA,MACF,SAAS,OAAO;AACd,eAAO;AAAA,MACT;AAAA,IACF;AAEA,WAAO;AAAA,MACL,eAAe;AAAA,QACb,OAAO,oBAAoB;AACzB,cAAI,SAAsC;AAC1C,cAAI,QAAQ,MAAM,QAAQ,MAAM;AAChC,cAAI,aAAa;AACjB,iBAAO,SAAS,QAAQ;AACtB;AACA,qBAAS,OAAM,+BAAQ;AAAA,cACrB,iBAAiB;AAAA,cACjB;AAAA,cACA;AAAA,YACF;AAEA,gBAAI,QAAQ;AACV,sBAAQ,MAAM,QAAQ,MAAM;AAAA,YAC9B;AAAA,UACF;AAAA,QACF;AAAA,QACA,EAAE,UAAU,aAAa;AAAA,MAC3B;AAAA,MACA,eAAe,YAAY;AACzB,cAAM,cAAc,MAAM,QAAQ,QAAQ,GAAG;AAE7C,YAAI,CAAC,aAAa;AAChB;AAAA,QACF;AAEA,eAAO,YAAY,WAAW;AAAA,MAChC;AAAA,MACA,cAAc,MAAM,QAAQ,WAAW,GAAG;AAAA,IAC5C;AAAA,EACF;AAEA,SAAO;AAAA,IACL,eAAe;AAAA,IACf,eAAe,MAAM,QAAQ,QAAQ,MAAS;AAAA,IAC9C,cAAc;AAAA,EAChB;AACF;AAGA,SAAS,OAAO;AAAC;","names":[]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/asyncThrottle.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
|
|
1
|
+
{"version":3,"sources":["../../src/asyncThrottle.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 ReadonlyArray<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"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAKA,IAAM,OAAO,MAAM;AAEnB;AAEO,SAAS,cACd,MACA,EAAE,WAAW,KAAM,UAAU,KAAK,IAA0B,CAAC,GAC7D;AACA,MAAI,OAAO,SAAS;AAAY,UAAM,IAAI,MAAM,2BAA2B;AAE3E,MAAI,UAAU;AACd,MAAI,WAAW;AACf,MAAI;AACJ,MAAI,cAA2B;AAE/B,QAAM,WAAW,YAAY;AAC3B,QAAI,aAAa;AACf,YAAM,OAAO;AACb,oBAAc;AACd,UAAI;AACF,kBAAU;AACV,cAAM,KAAK,GAAG,IAAI;AAAA,MACpB,SAAS,OAAO;AACd,gBAAQ,KAAK;AAAA,MACf,UAAE;AACA,mBAAW,KAAK,IAAI;AACpB,kBAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,QAAM,YAAY,YAAY;AAC5B,iBAAa,OAAO;AACpB,cAAU,WAAW,MAAM;AACzB,UAAI,SAAS;AACX,kBAAU;AAAA,MACZ,OAAO;AACL,iBAAS;AAAA,MACX;AAAA,IACF,GAAG,QAAQ;AAAA,EACb;AAEA,SAAO,IAAI,SAAe;AACxB,kBAAc;AAEd,UAAM,UAAU,KAAK,IAAI,IAAI,WAAW;AACxC,QAAI,WAAW,SAAS;AACtB,gBAAU;AAAA,IACZ,OAAO;AACL,eAAS;AAAA,IACX;AAAA,EACF;AACF;","names":[]}
|
|
@@ -2,6 +2,6 @@ interface AsyncThrottleOptions {
|
|
|
2
2
|
interval?: number;
|
|
3
3
|
onError?: (error: unknown) => void;
|
|
4
4
|
}
|
|
5
|
-
declare function asyncThrottle<Args extends
|
|
5
|
+
declare function asyncThrottle<Args extends ReadonlyArray<unknown>>(func: (...args: Args) => Promise<void>, { interval, onError }?: AsyncThrottleOptions): (...args: Args) => void;
|
|
6
6
|
|
|
7
7
|
export { AsyncThrottleOptions, asyncThrottle };
|
|
@@ -2,6 +2,6 @@ interface AsyncThrottleOptions {
|
|
|
2
2
|
interval?: number;
|
|
3
3
|
onError?: (error: unknown) => void;
|
|
4
4
|
}
|
|
5
|
-
declare function asyncThrottle<Args extends
|
|
5
|
+
declare function asyncThrottle<Args extends ReadonlyArray<unknown>>(func: (...args: Args) => Promise<void>, { interval, onError }?: AsyncThrottleOptions): (...args: Args) => void;
|
|
6
6
|
|
|
7
7
|
export { AsyncThrottleOptions, asyncThrottle };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/asyncThrottle.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
|
|
1
|
+
{"version":3,"sources":["../../src/asyncThrottle.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 ReadonlyArray<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"],"mappings":";AAKA,IAAM,OAAO,MAAM;AAEnB;AAEO,SAAS,cACd,MACA,EAAE,WAAW,KAAM,UAAU,KAAK,IAA0B,CAAC,GAC7D;AACA,MAAI,OAAO,SAAS;AAAY,UAAM,IAAI,MAAM,2BAA2B;AAE3E,MAAI,UAAU;AACd,MAAI,WAAW;AACf,MAAI;AACJ,MAAI,cAA2B;AAE/B,QAAM,WAAW,YAAY;AAC3B,QAAI,aAAa;AACf,YAAM,OAAO;AACb,oBAAc;AACd,UAAI;AACF,kBAAU;AACV,cAAM,KAAK,GAAG,IAAI;AAAA,MACpB,SAAS,OAAO;AACd,gBAAQ,KAAK;AAAA,MACf,UAAE;AACA,mBAAW,KAAK,IAAI;AACpB,kBAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,QAAM,YAAY,YAAY;AAC5B,iBAAa,OAAO;AACpB,cAAU,WAAW,MAAM;AACzB,UAAI,SAAS;AACX,kBAAU;AAAA,MACZ,OAAO;AACL,iBAAS;AAAA,MACX;AAAA,IACF,GAAG,QAAQ;AAAA,EACb;AAEA,SAAO,IAAI,SAAe;AACxB,kBAAc;AAEd,UAAM,UAAU,KAAK,IAAI,IAAI,WAAW;AACxC,QAAI,WAAW,SAAS;AACtB,gBAAU;AAAA,IACZ,OAAO;AACL,eAAS;AAAA,IACX;AAAA,EACF;AACF;","names":[]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import { asyncThrottle } from './asyncThrottle'\nimport type {\n PersistedClient,\n Persister,\n Promisable,\n} from '@tanstack/query-persist-client-core'\n\
|
|
1
|
+
{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import { asyncThrottle } from './asyncThrottle'\nimport type {\n AsyncStorage,\n PersistedClient,\n Persister,\n Promisable,\n} from '@tanstack/query-persist-client-core'\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`. Note that window.localStorage can be\n * `null` in Android WebViews depending on how they are configured.\n */\n storage: AsyncStorage | undefined | null\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 (storage) {\n const trySave = async (\n persistedClient: PersistedClient,\n ): Promise<Error | undefined> => {\n try {\n await storage.setItem(key, serialize(persistedClient))\n return\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)\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"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,2BAA8B;AAuCvB,IAAM,8BAA8B,CAAC;AAAA,EAC1C;AAAA,EACA,MAAM;AAAA,EACN,eAAe;AAAA,EACf,YAAY,KAAK;AAAA,EACjB,cAAc,KAAK;AAAA,EACnB;AACF,MAAqD;AACnD,MAAI,SAAS;AACX,UAAM,UAAU,OACd,oBAC+B;AAC/B,UAAI;AACF,cAAM,QAAQ,QAAQ,KAAK,UAAU,eAAe,CAAC;AACrD;AAAA,MACF,SAAS,OAAO;AACd,eAAO;AAAA,MACT;AAAA,IACF;AAEA,WAAO;AAAA,MACL,mBAAe;AAAA,QACb,OAAO,oBAAoB;AACzB,cAAI,SAAsC;AAC1C,cAAI,QAAQ,MAAM,QAAQ,MAAM;AAChC,cAAI,aAAa;AACjB,iBAAO,SAAS,QAAQ;AACtB;AACA,qBAAS,MAAM,QAAQ;AAAA,cACrB,iBAAiB;AAAA,cACjB;AAAA,cACA;AAAA,YACF,CAAC;AAED,gBAAI,QAAQ;AACV,sBAAQ,MAAM,QAAQ,MAAM;AAAA,YAC9B;AAAA,UACF;AAAA,QACF;AAAA,QACA,EAAE,UAAU,aAAa;AAAA,MAC3B;AAAA,MACA,eAAe,YAAY;AACzB,cAAM,cAAc,MAAM,QAAQ,QAAQ,GAAG;AAE7C,YAAI,CAAC,aAAa;AAChB;AAAA,QACF;AAEA,eAAO,YAAY,WAAW;AAAA,MAChC;AAAA,MACA,cAAc,MAAM,QAAQ,WAAW,GAAG;AAAA,IAC5C;AAAA,EACF;AAEA,SAAO;AAAA,IACL,eAAe;AAAA,IACf,eAAe,MAAM,QAAQ,QAAQ,MAAS;AAAA,IAC9C,cAAc;AAAA,EAChB;AACF;AAGA,SAAS,OAAO;AAAC;","names":[]}
|
package/build/modern/index.d.cts
CHANGED
|
@@ -1,10 +1,5 @@
|
|
|
1
|
-
import { PersistedClient, Promisable, Persister } from '@tanstack/query-persist-client-core';
|
|
1
|
+
import { PersistedClient, Promisable, Persister, AsyncStorage } from '@tanstack/query-persist-client-core';
|
|
2
2
|
|
|
3
|
-
interface AsyncStorage {
|
|
4
|
-
getItem: (key: string) => Promise<string | null>;
|
|
5
|
-
setItem: (key: string, value: string) => Promise<unknown>;
|
|
6
|
-
removeItem: (key: string) => Promise<void>;
|
|
7
|
-
}
|
|
8
3
|
type AsyncPersistRetryer = (props: {
|
|
9
4
|
persistedClient: PersistedClient;
|
|
10
5
|
error: Error;
|
package/build/modern/index.d.ts
CHANGED
|
@@ -1,10 +1,5 @@
|
|
|
1
|
-
import { PersistedClient, Promisable, Persister } from '@tanstack/query-persist-client-core';
|
|
1
|
+
import { PersistedClient, Promisable, Persister, AsyncStorage } from '@tanstack/query-persist-client-core';
|
|
2
2
|
|
|
3
|
-
interface AsyncStorage {
|
|
4
|
-
getItem: (key: string) => Promise<string | null>;
|
|
5
|
-
setItem: (key: string, value: string) => Promise<unknown>;
|
|
6
|
-
removeItem: (key: string) => Promise<void>;
|
|
7
|
-
}
|
|
8
3
|
type AsyncPersistRetryer = (props: {
|
|
9
4
|
persistedClient: PersistedClient;
|
|
10
5
|
error: Error;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import { asyncThrottle } from './asyncThrottle'\nimport type {\n PersistedClient,\n Persister,\n Promisable,\n} from '@tanstack/query-persist-client-core'\n\
|
|
1
|
+
{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import { asyncThrottle } from './asyncThrottle'\nimport type {\n AsyncStorage,\n PersistedClient,\n Persister,\n Promisable,\n} from '@tanstack/query-persist-client-core'\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`. Note that window.localStorage can be\n * `null` in Android WebViews depending on how they are configured.\n */\n storage: AsyncStorage | undefined | null\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 (storage) {\n const trySave = async (\n persistedClient: PersistedClient,\n ): Promise<Error | undefined> => {\n try {\n await storage.setItem(key, serialize(persistedClient))\n return\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)\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"],"mappings":";AAAA,SAAS,qBAAqB;AAuCvB,IAAM,8BAA8B,CAAC;AAAA,EAC1C;AAAA,EACA,MAAM;AAAA,EACN,eAAe;AAAA,EACf,YAAY,KAAK;AAAA,EACjB,cAAc,KAAK;AAAA,EACnB;AACF,MAAqD;AACnD,MAAI,SAAS;AACX,UAAM,UAAU,OACd,oBAC+B;AAC/B,UAAI;AACF,cAAM,QAAQ,QAAQ,KAAK,UAAU,eAAe,CAAC;AACrD;AAAA,MACF,SAAS,OAAO;AACd,eAAO;AAAA,MACT;AAAA,IACF;AAEA,WAAO;AAAA,MACL,eAAe;AAAA,QACb,OAAO,oBAAoB;AACzB,cAAI,SAAsC;AAC1C,cAAI,QAAQ,MAAM,QAAQ,MAAM;AAChC,cAAI,aAAa;AACjB,iBAAO,SAAS,QAAQ;AACtB;AACA,qBAAS,MAAM,QAAQ;AAAA,cACrB,iBAAiB;AAAA,cACjB;AAAA,cACA;AAAA,YACF,CAAC;AAED,gBAAI,QAAQ;AACV,sBAAQ,MAAM,QAAQ,MAAM;AAAA,YAC9B;AAAA,UACF;AAAA,QACF;AAAA,QACA,EAAE,UAAU,aAAa;AAAA,MAC3B;AAAA,MACA,eAAe,YAAY;AACzB,cAAM,cAAc,MAAM,QAAQ,QAAQ,GAAG;AAE7C,YAAI,CAAC,aAAa;AAChB;AAAA,QACF;AAEA,eAAO,YAAY,WAAW;AAAA,MAChC;AAAA,MACA,cAAc,MAAM,QAAQ,WAAW,GAAG;AAAA,IAC5C;AAAA,EACF;AAEA,SAAO;AAAA,IACL,eAAe;AAAA,IACf,eAAe,MAAM,QAAQ,QAAQ,MAAS;AAAA,IAC9C,cAAc;AAAA,EAChB;AACF;AAGA,SAAS,OAAO;AAAC;","names":[]}
|
package/package.json
CHANGED
|
@@ -1,10 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tanstack/query-async-storage-persister",
|
|
3
|
-
"version": "5.0.0-
|
|
3
|
+
"version": "5.0.0-rc.0",
|
|
4
4
|
"description": "A persister for asynchronous storages, to be used with TanStack/Query",
|
|
5
5
|
"author": "tannerlinsley",
|
|
6
6
|
"license": "MIT",
|
|
7
|
-
"repository":
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "https://github.com/TanStack/query.git",
|
|
10
|
+
"directory": "packages/query-async-storage-persister"
|
|
11
|
+
},
|
|
8
12
|
"homepage": "https://tanstack.com/query",
|
|
9
13
|
"funding": {
|
|
10
14
|
"type": "github",
|
|
@@ -33,7 +37,7 @@
|
|
|
33
37
|
"src"
|
|
34
38
|
],
|
|
35
39
|
"dependencies": {
|
|
36
|
-
"@tanstack/query-persist-client-core": "5.0.0-
|
|
40
|
+
"@tanstack/query-persist-client-core": "5.0.0-rc.0"
|
|
37
41
|
},
|
|
38
42
|
"scripts": {
|
|
39
43
|
"clean": "rimraf ./build && rimraf ./coverage",
|
|
@@ -5,7 +5,7 @@ import { sleep as delay } from './utils'
|
|
|
5
5
|
describe('asyncThrottle', () => {
|
|
6
6
|
test('basic', async () => {
|
|
7
7
|
const interval = 10
|
|
8
|
-
const execTimeStamps: number
|
|
8
|
+
const execTimeStamps: Array<number> = []
|
|
9
9
|
const mockFunc = vi.fn(
|
|
10
10
|
async (id: number, complete?: (value?: unknown) => void) => {
|
|
11
11
|
await delay(1)
|
|
@@ -33,7 +33,7 @@ describe('asyncThrottle', () => {
|
|
|
33
33
|
|
|
34
34
|
test('Bug #3331 case 1: Special timing', async () => {
|
|
35
35
|
const interval = 1000
|
|
36
|
-
const execTimeStamps: number
|
|
36
|
+
const execTimeStamps: Array<number> = []
|
|
37
37
|
const mockFunc = vi.fn(
|
|
38
38
|
async (id: number, complete?: (value?: unknown) => void) => {
|
|
39
39
|
await delay(30)
|
|
@@ -62,7 +62,7 @@ describe('asyncThrottle', () => {
|
|
|
62
62
|
|
|
63
63
|
test('Bug #3331 case 2: "func" execution time is greater than the interval.', async () => {
|
|
64
64
|
const interval = 1000
|
|
65
|
-
const execTimeStamps: number
|
|
65
|
+
const execTimeStamps: Array<number> = []
|
|
66
66
|
const mockFunc = vi.fn(
|
|
67
67
|
async (id: number, complete?: (value?: unknown) => void) => {
|
|
68
68
|
await delay(interval + 10)
|
package/src/asyncThrottle.ts
CHANGED
|
@@ -7,7 +7,7 @@ const noop = () => {
|
|
|
7
7
|
/* do nothing */
|
|
8
8
|
}
|
|
9
9
|
|
|
10
|
-
export function asyncThrottle<Args extends
|
|
10
|
+
export function asyncThrottle<Args extends ReadonlyArray<unknown>>(
|
|
11
11
|
func: (...args: Args) => Promise<void>,
|
|
12
12
|
{ interval = 1000, onError = noop }: AsyncThrottleOptions = {},
|
|
13
13
|
) {
|
package/src/index.ts
CHANGED
|
@@ -1,16 +1,11 @@
|
|
|
1
1
|
import { asyncThrottle } from './asyncThrottle'
|
|
2
2
|
import type {
|
|
3
|
+
AsyncStorage,
|
|
3
4
|
PersistedClient,
|
|
4
5
|
Persister,
|
|
5
6
|
Promisable,
|
|
6
7
|
} from '@tanstack/query-persist-client-core'
|
|
7
8
|
|
|
8
|
-
interface AsyncStorage {
|
|
9
|
-
getItem: (key: string) => Promise<string | null>
|
|
10
|
-
setItem: (key: string, value: string) => Promise<unknown>
|
|
11
|
-
removeItem: (key: string) => Promise<void>
|
|
12
|
-
}
|
|
13
|
-
|
|
14
9
|
export type AsyncPersistRetryer = (props: {
|
|
15
10
|
persistedClient: PersistedClient
|
|
16
11
|
error: Error
|