@tanstack/query-sync-storage-persister 5.81.2 → 5.81.4
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/index.cjs.map +1 -1
- package/build/legacy/index.d.cts +3 -0
- package/build/legacy/index.d.ts +3 -0
- package/build/legacy/index.js.map +1 -1
- package/build/modern/index.cjs.map +1 -1
- package/build/modern/index.d.cts +3 -0
- package/build/modern/index.d.ts +3 -0
- package/build/modern/index.js.map +1 -1
- package/package.json +22 -4
- package/src/index.ts +3 -0
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import { noop } from './utils'\nimport type {\n PersistRetryer,\n PersistedClient,\n Persister,\n} from '@tanstack/query-persist-client-core'\n\ninterface Storage {\n getItem: (key: string) => string | null\n setItem: (key: string, value: string) => void\n removeItem: (key: string) => void\n}\n\ninterface CreateSyncStoragePersisterOptions {\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: Storage | 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?: PersistRetryer\n}\n\nexport function createSyncStoragePersister({\n storage,\n key = `REACT_QUERY_OFFLINE_CACHE`,\n throttleTime = 1000,\n serialize = JSON.stringify,\n deserialize = JSON.parse,\n retry,\n}: CreateSyncStoragePersisterOptions): Persister {\n if (storage) {\n const trySave = (persistedClient: PersistedClient): Error | undefined => {\n try {\n storage.setItem(key, serialize(persistedClient))\n return\n } catch (error) {\n return error as Error\n }\n }\n return {\n persistClient: throttle((persistedClient) => {\n let client: PersistedClient | undefined = persistedClient\n let error = trySave(client)\n let errorCount = 0\n while (error && client) {\n errorCount++\n client = retry?.({\n persistedClient: client,\n error,\n errorCount,\n })\n\n if (client) {\n error = trySave(client)\n }\n }\n }, throttleTime),\n restoreClient: () => {\n const cacheString = storage.getItem(key)\n\n if (!cacheString) {\n return\n }\n\n return deserialize(cacheString)\n },\n removeClient: () => {\n storage.removeItem(key)\n },\n }\n }\n\n return {\n persistClient: noop,\n restoreClient: noop,\n removeClient: noop,\n }\n}\n\nfunction throttle<TArgs extends Array<any>>(\n func: (...args: TArgs) => any,\n wait = 100,\n) {\n let timer: ReturnType<typeof setTimeout> | null = null\n let params: TArgs\n return function (...args: TArgs) {\n params = args\n if (timer === null) {\n timer = setTimeout(() => {\n func(...params)\n timer = null\n }, wait)\n }\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAqB;
|
|
1
|
+
{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import { noop } from './utils'\nimport type {\n PersistRetryer,\n PersistedClient,\n Persister,\n} from '@tanstack/query-persist-client-core'\n\ninterface Storage {\n getItem: (key: string) => string | null\n setItem: (key: string, value: string) => void\n removeItem: (key: string) => void\n}\n\ninterface CreateSyncStoragePersisterOptions {\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: Storage | 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?: PersistRetryer\n}\n\n/**\n * @deprecated use `createAsyncStoragePersister` from `@tanstack/query-async-storage-persister` instead.\n */\nexport function createSyncStoragePersister({\n storage,\n key = `REACT_QUERY_OFFLINE_CACHE`,\n throttleTime = 1000,\n serialize = JSON.stringify,\n deserialize = JSON.parse,\n retry,\n}: CreateSyncStoragePersisterOptions): Persister {\n if (storage) {\n const trySave = (persistedClient: PersistedClient): Error | undefined => {\n try {\n storage.setItem(key, serialize(persistedClient))\n return\n } catch (error) {\n return error as Error\n }\n }\n return {\n persistClient: throttle((persistedClient) => {\n let client: PersistedClient | undefined = persistedClient\n let error = trySave(client)\n let errorCount = 0\n while (error && client) {\n errorCount++\n client = retry?.({\n persistedClient: client,\n error,\n errorCount,\n })\n\n if (client) {\n error = trySave(client)\n }\n }\n }, throttleTime),\n restoreClient: () => {\n const cacheString = storage.getItem(key)\n\n if (!cacheString) {\n return\n }\n\n return deserialize(cacheString)\n },\n removeClient: () => {\n storage.removeItem(key)\n },\n }\n }\n\n return {\n persistClient: noop,\n restoreClient: noop,\n removeClient: noop,\n }\n}\n\nfunction throttle<TArgs extends Array<any>>(\n func: (...args: TArgs) => any,\n wait = 100,\n) {\n let timer: ReturnType<typeof setTimeout> | null = null\n let params: TArgs\n return function (...args: TArgs) {\n params = args\n if (timer === null) {\n timer = setTimeout(() => {\n func(...params)\n timer = null\n }, wait)\n }\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAqB;AAyCd,SAAS,2BAA2B;AAAA,EACzC;AAAA,EACA,MAAM;AAAA,EACN,eAAe;AAAA,EACf,YAAY,KAAK;AAAA,EACjB,cAAc,KAAK;AAAA,EACnB;AACF,GAAiD;AAC/C,MAAI,SAAS;AACX,UAAM,UAAU,CAAC,oBAAwD;AACvE,UAAI;AACF,gBAAQ,QAAQ,KAAK,UAAU,eAAe,CAAC;AAC/C;AAAA,MACF,SAAS,OAAO;AACd,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO;AAAA,MACL,eAAe,SAAS,CAAC,oBAAoB;AAC3C,YAAI,SAAsC;AAC1C,YAAI,QAAQ,QAAQ,MAAM;AAC1B,YAAI,aAAa;AACjB,eAAO,SAAS,QAAQ;AACtB;AACA,mBAAS,+BAAQ;AAAA,YACf,iBAAiB;AAAA,YACjB;AAAA,YACA;AAAA,UACF;AAEA,cAAI,QAAQ;AACV,oBAAQ,QAAQ,MAAM;AAAA,UACxB;AAAA,QACF;AAAA,MACF,GAAG,YAAY;AAAA,MACf,eAAe,MAAM;AACnB,cAAM,cAAc,QAAQ,QAAQ,GAAG;AAEvC,YAAI,CAAC,aAAa;AAChB;AAAA,QACF;AAEA,eAAO,YAAY,WAAW;AAAA,MAChC;AAAA,MACA,cAAc,MAAM;AAClB,gBAAQ,WAAW,GAAG;AAAA,MACxB;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AAAA,IACL,eAAe;AAAA,IACf,eAAe;AAAA,IACf,cAAc;AAAA,EAChB;AACF;AAEA,SAAS,SACP,MACA,OAAO,KACP;AACA,MAAI,QAA8C;AAClD,MAAI;AACJ,SAAO,YAAa,MAAa;AAC/B,aAAS;AACT,QAAI,UAAU,MAAM;AAClB,cAAQ,WAAW,MAAM;AACvB,aAAK,GAAG,MAAM;AACd,gBAAQ;AAAA,MACV,GAAG,IAAI;AAAA,IACT;AAAA,EACF;AACF;","names":[]}
|
package/build/legacy/index.d.cts
CHANGED
|
@@ -28,6 +28,9 @@ interface CreateSyncStoragePersisterOptions {
|
|
|
28
28
|
deserialize?: (cachedString: string) => PersistedClient;
|
|
29
29
|
retry?: PersistRetryer;
|
|
30
30
|
}
|
|
31
|
+
/**
|
|
32
|
+
* @deprecated use `createAsyncStoragePersister` from `@tanstack/query-async-storage-persister` instead.
|
|
33
|
+
*/
|
|
31
34
|
declare function createSyncStoragePersister({ storage, key, throttleTime, serialize, deserialize, retry, }: CreateSyncStoragePersisterOptions): Persister;
|
|
32
35
|
|
|
33
36
|
export { createSyncStoragePersister };
|
package/build/legacy/index.d.ts
CHANGED
|
@@ -28,6 +28,9 @@ interface CreateSyncStoragePersisterOptions {
|
|
|
28
28
|
deserialize?: (cachedString: string) => PersistedClient;
|
|
29
29
|
retry?: PersistRetryer;
|
|
30
30
|
}
|
|
31
|
+
/**
|
|
32
|
+
* @deprecated use `createAsyncStoragePersister` from `@tanstack/query-async-storage-persister` instead.
|
|
33
|
+
*/
|
|
31
34
|
declare function createSyncStoragePersister({ storage, key, throttleTime, serialize, deserialize, retry, }: CreateSyncStoragePersisterOptions): Persister;
|
|
32
35
|
|
|
33
36
|
export { createSyncStoragePersister };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import { noop } from './utils'\nimport type {\n PersistRetryer,\n PersistedClient,\n Persister,\n} from '@tanstack/query-persist-client-core'\n\ninterface Storage {\n getItem: (key: string) => string | null\n setItem: (key: string, value: string) => void\n removeItem: (key: string) => void\n}\n\ninterface CreateSyncStoragePersisterOptions {\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: Storage | 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?: PersistRetryer\n}\n\nexport function createSyncStoragePersister({\n storage,\n key = `REACT_QUERY_OFFLINE_CACHE`,\n throttleTime = 1000,\n serialize = JSON.stringify,\n deserialize = JSON.parse,\n retry,\n}: CreateSyncStoragePersisterOptions): Persister {\n if (storage) {\n const trySave = (persistedClient: PersistedClient): Error | undefined => {\n try {\n storage.setItem(key, serialize(persistedClient))\n return\n } catch (error) {\n return error as Error\n }\n }\n return {\n persistClient: throttle((persistedClient) => {\n let client: PersistedClient | undefined = persistedClient\n let error = trySave(client)\n let errorCount = 0\n while (error && client) {\n errorCount++\n client = retry?.({\n persistedClient: client,\n error,\n errorCount,\n })\n\n if (client) {\n error = trySave(client)\n }\n }\n }, throttleTime),\n restoreClient: () => {\n const cacheString = storage.getItem(key)\n\n if (!cacheString) {\n return\n }\n\n return deserialize(cacheString)\n },\n removeClient: () => {\n storage.removeItem(key)\n },\n }\n }\n\n return {\n persistClient: noop,\n restoreClient: noop,\n removeClient: noop,\n }\n}\n\nfunction throttle<TArgs extends Array<any>>(\n func: (...args: TArgs) => any,\n wait = 100,\n) {\n let timer: ReturnType<typeof setTimeout> | null = null\n let params: TArgs\n return function (...args: TArgs) {\n params = args\n if (timer === null) {\n timer = setTimeout(() => {\n func(...params)\n timer = null\n }, wait)\n }\n }\n}\n"],"mappings":";AAAA,SAAS,YAAY;
|
|
1
|
+
{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import { noop } from './utils'\nimport type {\n PersistRetryer,\n PersistedClient,\n Persister,\n} from '@tanstack/query-persist-client-core'\n\ninterface Storage {\n getItem: (key: string) => string | null\n setItem: (key: string, value: string) => void\n removeItem: (key: string) => void\n}\n\ninterface CreateSyncStoragePersisterOptions {\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: Storage | 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?: PersistRetryer\n}\n\n/**\n * @deprecated use `createAsyncStoragePersister` from `@tanstack/query-async-storage-persister` instead.\n */\nexport function createSyncStoragePersister({\n storage,\n key = `REACT_QUERY_OFFLINE_CACHE`,\n throttleTime = 1000,\n serialize = JSON.stringify,\n deserialize = JSON.parse,\n retry,\n}: CreateSyncStoragePersisterOptions): Persister {\n if (storage) {\n const trySave = (persistedClient: PersistedClient): Error | undefined => {\n try {\n storage.setItem(key, serialize(persistedClient))\n return\n } catch (error) {\n return error as Error\n }\n }\n return {\n persistClient: throttle((persistedClient) => {\n let client: PersistedClient | undefined = persistedClient\n let error = trySave(client)\n let errorCount = 0\n while (error && client) {\n errorCount++\n client = retry?.({\n persistedClient: client,\n error,\n errorCount,\n })\n\n if (client) {\n error = trySave(client)\n }\n }\n }, throttleTime),\n restoreClient: () => {\n const cacheString = storage.getItem(key)\n\n if (!cacheString) {\n return\n }\n\n return deserialize(cacheString)\n },\n removeClient: () => {\n storage.removeItem(key)\n },\n }\n }\n\n return {\n persistClient: noop,\n restoreClient: noop,\n removeClient: noop,\n }\n}\n\nfunction throttle<TArgs extends Array<any>>(\n func: (...args: TArgs) => any,\n wait = 100,\n) {\n let timer: ReturnType<typeof setTimeout> | null = null\n let params: TArgs\n return function (...args: TArgs) {\n params = args\n if (timer === null) {\n timer = setTimeout(() => {\n func(...params)\n timer = null\n }, wait)\n }\n }\n}\n"],"mappings":";AAAA,SAAS,YAAY;AAyCd,SAAS,2BAA2B;AAAA,EACzC;AAAA,EACA,MAAM;AAAA,EACN,eAAe;AAAA,EACf,YAAY,KAAK;AAAA,EACjB,cAAc,KAAK;AAAA,EACnB;AACF,GAAiD;AAC/C,MAAI,SAAS;AACX,UAAM,UAAU,CAAC,oBAAwD;AACvE,UAAI;AACF,gBAAQ,QAAQ,KAAK,UAAU,eAAe,CAAC;AAC/C;AAAA,MACF,SAAS,OAAO;AACd,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO;AAAA,MACL,eAAe,SAAS,CAAC,oBAAoB;AAC3C,YAAI,SAAsC;AAC1C,YAAI,QAAQ,QAAQ,MAAM;AAC1B,YAAI,aAAa;AACjB,eAAO,SAAS,QAAQ;AACtB;AACA,mBAAS,+BAAQ;AAAA,YACf,iBAAiB;AAAA,YACjB;AAAA,YACA;AAAA,UACF;AAEA,cAAI,QAAQ;AACV,oBAAQ,QAAQ,MAAM;AAAA,UACxB;AAAA,QACF;AAAA,MACF,GAAG,YAAY;AAAA,MACf,eAAe,MAAM;AACnB,cAAM,cAAc,QAAQ,QAAQ,GAAG;AAEvC,YAAI,CAAC,aAAa;AAChB;AAAA,QACF;AAEA,eAAO,YAAY,WAAW;AAAA,MAChC;AAAA,MACA,cAAc,MAAM;AAClB,gBAAQ,WAAW,GAAG;AAAA,MACxB;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AAAA,IACL,eAAe;AAAA,IACf,eAAe;AAAA,IACf,cAAc;AAAA,EAChB;AACF;AAEA,SAAS,SACP,MACA,OAAO,KACP;AACA,MAAI,QAA8C;AAClD,MAAI;AACJ,SAAO,YAAa,MAAa;AAC/B,aAAS;AACT,QAAI,UAAU,MAAM;AAClB,cAAQ,WAAW,MAAM;AACvB,aAAK,GAAG,MAAM;AACd,gBAAQ;AAAA,MACV,GAAG,IAAI;AAAA,IACT;AAAA,EACF;AACF;","names":[]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import { noop } from './utils'\nimport type {\n PersistRetryer,\n PersistedClient,\n Persister,\n} from '@tanstack/query-persist-client-core'\n\ninterface Storage {\n getItem: (key: string) => string | null\n setItem: (key: string, value: string) => void\n removeItem: (key: string) => void\n}\n\ninterface CreateSyncStoragePersisterOptions {\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: Storage | 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?: PersistRetryer\n}\n\nexport function createSyncStoragePersister({\n storage,\n key = `REACT_QUERY_OFFLINE_CACHE`,\n throttleTime = 1000,\n serialize = JSON.stringify,\n deserialize = JSON.parse,\n retry,\n}: CreateSyncStoragePersisterOptions): Persister {\n if (storage) {\n const trySave = (persistedClient: PersistedClient): Error | undefined => {\n try {\n storage.setItem(key, serialize(persistedClient))\n return\n } catch (error) {\n return error as Error\n }\n }\n return {\n persistClient: throttle((persistedClient) => {\n let client: PersistedClient | undefined = persistedClient\n let error = trySave(client)\n let errorCount = 0\n while (error && client) {\n errorCount++\n client = retry?.({\n persistedClient: client,\n error,\n errorCount,\n })\n\n if (client) {\n error = trySave(client)\n }\n }\n }, throttleTime),\n restoreClient: () => {\n const cacheString = storage.getItem(key)\n\n if (!cacheString) {\n return\n }\n\n return deserialize(cacheString)\n },\n removeClient: () => {\n storage.removeItem(key)\n },\n }\n }\n\n return {\n persistClient: noop,\n restoreClient: noop,\n removeClient: noop,\n }\n}\n\nfunction throttle<TArgs extends Array<any>>(\n func: (...args: TArgs) => any,\n wait = 100,\n) {\n let timer: ReturnType<typeof setTimeout> | null = null\n let params: TArgs\n return function (...args: TArgs) {\n params = args\n if (timer === null) {\n timer = setTimeout(() => {\n func(...params)\n timer = null\n }, wait)\n }\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAqB;
|
|
1
|
+
{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import { noop } from './utils'\nimport type {\n PersistRetryer,\n PersistedClient,\n Persister,\n} from '@tanstack/query-persist-client-core'\n\ninterface Storage {\n getItem: (key: string) => string | null\n setItem: (key: string, value: string) => void\n removeItem: (key: string) => void\n}\n\ninterface CreateSyncStoragePersisterOptions {\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: Storage | 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?: PersistRetryer\n}\n\n/**\n * @deprecated use `createAsyncStoragePersister` from `@tanstack/query-async-storage-persister` instead.\n */\nexport function createSyncStoragePersister({\n storage,\n key = `REACT_QUERY_OFFLINE_CACHE`,\n throttleTime = 1000,\n serialize = JSON.stringify,\n deserialize = JSON.parse,\n retry,\n}: CreateSyncStoragePersisterOptions): Persister {\n if (storage) {\n const trySave = (persistedClient: PersistedClient): Error | undefined => {\n try {\n storage.setItem(key, serialize(persistedClient))\n return\n } catch (error) {\n return error as Error\n }\n }\n return {\n persistClient: throttle((persistedClient) => {\n let client: PersistedClient | undefined = persistedClient\n let error = trySave(client)\n let errorCount = 0\n while (error && client) {\n errorCount++\n client = retry?.({\n persistedClient: client,\n error,\n errorCount,\n })\n\n if (client) {\n error = trySave(client)\n }\n }\n }, throttleTime),\n restoreClient: () => {\n const cacheString = storage.getItem(key)\n\n if (!cacheString) {\n return\n }\n\n return deserialize(cacheString)\n },\n removeClient: () => {\n storage.removeItem(key)\n },\n }\n }\n\n return {\n persistClient: noop,\n restoreClient: noop,\n removeClient: noop,\n }\n}\n\nfunction throttle<TArgs extends Array<any>>(\n func: (...args: TArgs) => any,\n wait = 100,\n) {\n let timer: ReturnType<typeof setTimeout> | null = null\n let params: TArgs\n return function (...args: TArgs) {\n params = args\n if (timer === null) {\n timer = setTimeout(() => {\n func(...params)\n timer = null\n }, wait)\n }\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAqB;AAyCd,SAAS,2BAA2B;AAAA,EACzC;AAAA,EACA,MAAM;AAAA,EACN,eAAe;AAAA,EACf,YAAY,KAAK;AAAA,EACjB,cAAc,KAAK;AAAA,EACnB;AACF,GAAiD;AAC/C,MAAI,SAAS;AACX,UAAM,UAAU,CAAC,oBAAwD;AACvE,UAAI;AACF,gBAAQ,QAAQ,KAAK,UAAU,eAAe,CAAC;AAC/C;AAAA,MACF,SAAS,OAAO;AACd,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO;AAAA,MACL,eAAe,SAAS,CAAC,oBAAoB;AAC3C,YAAI,SAAsC;AAC1C,YAAI,QAAQ,QAAQ,MAAM;AAC1B,YAAI,aAAa;AACjB,eAAO,SAAS,QAAQ;AACtB;AACA,mBAAS,QAAQ;AAAA,YACf,iBAAiB;AAAA,YACjB;AAAA,YACA;AAAA,UACF,CAAC;AAED,cAAI,QAAQ;AACV,oBAAQ,QAAQ,MAAM;AAAA,UACxB;AAAA,QACF;AAAA,MACF,GAAG,YAAY;AAAA,MACf,eAAe,MAAM;AACnB,cAAM,cAAc,QAAQ,QAAQ,GAAG;AAEvC,YAAI,CAAC,aAAa;AAChB;AAAA,QACF;AAEA,eAAO,YAAY,WAAW;AAAA,MAChC;AAAA,MACA,cAAc,MAAM;AAClB,gBAAQ,WAAW,GAAG;AAAA,MACxB;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AAAA,IACL,eAAe;AAAA,IACf,eAAe;AAAA,IACf,cAAc;AAAA,EAChB;AACF;AAEA,SAAS,SACP,MACA,OAAO,KACP;AACA,MAAI,QAA8C;AAClD,MAAI;AACJ,SAAO,YAAa,MAAa;AAC/B,aAAS;AACT,QAAI,UAAU,MAAM;AAClB,cAAQ,WAAW,MAAM;AACvB,aAAK,GAAG,MAAM;AACd,gBAAQ;AAAA,MACV,GAAG,IAAI;AAAA,IACT;AAAA,EACF;AACF;","names":[]}
|
package/build/modern/index.d.cts
CHANGED
|
@@ -28,6 +28,9 @@ interface CreateSyncStoragePersisterOptions {
|
|
|
28
28
|
deserialize?: (cachedString: string) => PersistedClient;
|
|
29
29
|
retry?: PersistRetryer;
|
|
30
30
|
}
|
|
31
|
+
/**
|
|
32
|
+
* @deprecated use `createAsyncStoragePersister` from `@tanstack/query-async-storage-persister` instead.
|
|
33
|
+
*/
|
|
31
34
|
declare function createSyncStoragePersister({ storage, key, throttleTime, serialize, deserialize, retry, }: CreateSyncStoragePersisterOptions): Persister;
|
|
32
35
|
|
|
33
36
|
export { createSyncStoragePersister };
|
package/build/modern/index.d.ts
CHANGED
|
@@ -28,6 +28,9 @@ interface CreateSyncStoragePersisterOptions {
|
|
|
28
28
|
deserialize?: (cachedString: string) => PersistedClient;
|
|
29
29
|
retry?: PersistRetryer;
|
|
30
30
|
}
|
|
31
|
+
/**
|
|
32
|
+
* @deprecated use `createAsyncStoragePersister` from `@tanstack/query-async-storage-persister` instead.
|
|
33
|
+
*/
|
|
31
34
|
declare function createSyncStoragePersister({ storage, key, throttleTime, serialize, deserialize, retry, }: CreateSyncStoragePersisterOptions): Persister;
|
|
32
35
|
|
|
33
36
|
export { createSyncStoragePersister };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import { noop } from './utils'\nimport type {\n PersistRetryer,\n PersistedClient,\n Persister,\n} from '@tanstack/query-persist-client-core'\n\ninterface Storage {\n getItem: (key: string) => string | null\n setItem: (key: string, value: string) => void\n removeItem: (key: string) => void\n}\n\ninterface CreateSyncStoragePersisterOptions {\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: Storage | 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?: PersistRetryer\n}\n\nexport function createSyncStoragePersister({\n storage,\n key = `REACT_QUERY_OFFLINE_CACHE`,\n throttleTime = 1000,\n serialize = JSON.stringify,\n deserialize = JSON.parse,\n retry,\n}: CreateSyncStoragePersisterOptions): Persister {\n if (storage) {\n const trySave = (persistedClient: PersistedClient): Error | undefined => {\n try {\n storage.setItem(key, serialize(persistedClient))\n return\n } catch (error) {\n return error as Error\n }\n }\n return {\n persistClient: throttle((persistedClient) => {\n let client: PersistedClient | undefined = persistedClient\n let error = trySave(client)\n let errorCount = 0\n while (error && client) {\n errorCount++\n client = retry?.({\n persistedClient: client,\n error,\n errorCount,\n })\n\n if (client) {\n error = trySave(client)\n }\n }\n }, throttleTime),\n restoreClient: () => {\n const cacheString = storage.getItem(key)\n\n if (!cacheString) {\n return\n }\n\n return deserialize(cacheString)\n },\n removeClient: () => {\n storage.removeItem(key)\n },\n }\n }\n\n return {\n persistClient: noop,\n restoreClient: noop,\n removeClient: noop,\n }\n}\n\nfunction throttle<TArgs extends Array<any>>(\n func: (...args: TArgs) => any,\n wait = 100,\n) {\n let timer: ReturnType<typeof setTimeout> | null = null\n let params: TArgs\n return function (...args: TArgs) {\n params = args\n if (timer === null) {\n timer = setTimeout(() => {\n func(...params)\n timer = null\n }, wait)\n }\n }\n}\n"],"mappings":";AAAA,SAAS,YAAY;
|
|
1
|
+
{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import { noop } from './utils'\nimport type {\n PersistRetryer,\n PersistedClient,\n Persister,\n} from '@tanstack/query-persist-client-core'\n\ninterface Storage {\n getItem: (key: string) => string | null\n setItem: (key: string, value: string) => void\n removeItem: (key: string) => void\n}\n\ninterface CreateSyncStoragePersisterOptions {\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: Storage | 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?: PersistRetryer\n}\n\n/**\n * @deprecated use `createAsyncStoragePersister` from `@tanstack/query-async-storage-persister` instead.\n */\nexport function createSyncStoragePersister({\n storage,\n key = `REACT_QUERY_OFFLINE_CACHE`,\n throttleTime = 1000,\n serialize = JSON.stringify,\n deserialize = JSON.parse,\n retry,\n}: CreateSyncStoragePersisterOptions): Persister {\n if (storage) {\n const trySave = (persistedClient: PersistedClient): Error | undefined => {\n try {\n storage.setItem(key, serialize(persistedClient))\n return\n } catch (error) {\n return error as Error\n }\n }\n return {\n persistClient: throttle((persistedClient) => {\n let client: PersistedClient | undefined = persistedClient\n let error = trySave(client)\n let errorCount = 0\n while (error && client) {\n errorCount++\n client = retry?.({\n persistedClient: client,\n error,\n errorCount,\n })\n\n if (client) {\n error = trySave(client)\n }\n }\n }, throttleTime),\n restoreClient: () => {\n const cacheString = storage.getItem(key)\n\n if (!cacheString) {\n return\n }\n\n return deserialize(cacheString)\n },\n removeClient: () => {\n storage.removeItem(key)\n },\n }\n }\n\n return {\n persistClient: noop,\n restoreClient: noop,\n removeClient: noop,\n }\n}\n\nfunction throttle<TArgs extends Array<any>>(\n func: (...args: TArgs) => any,\n wait = 100,\n) {\n let timer: ReturnType<typeof setTimeout> | null = null\n let params: TArgs\n return function (...args: TArgs) {\n params = args\n if (timer === null) {\n timer = setTimeout(() => {\n func(...params)\n timer = null\n }, wait)\n }\n }\n}\n"],"mappings":";AAAA,SAAS,YAAY;AAyCd,SAAS,2BAA2B;AAAA,EACzC;AAAA,EACA,MAAM;AAAA,EACN,eAAe;AAAA,EACf,YAAY,KAAK;AAAA,EACjB,cAAc,KAAK;AAAA,EACnB;AACF,GAAiD;AAC/C,MAAI,SAAS;AACX,UAAM,UAAU,CAAC,oBAAwD;AACvE,UAAI;AACF,gBAAQ,QAAQ,KAAK,UAAU,eAAe,CAAC;AAC/C;AAAA,MACF,SAAS,OAAO;AACd,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO;AAAA,MACL,eAAe,SAAS,CAAC,oBAAoB;AAC3C,YAAI,SAAsC;AAC1C,YAAI,QAAQ,QAAQ,MAAM;AAC1B,YAAI,aAAa;AACjB,eAAO,SAAS,QAAQ;AACtB;AACA,mBAAS,QAAQ;AAAA,YACf,iBAAiB;AAAA,YACjB;AAAA,YACA;AAAA,UACF,CAAC;AAED,cAAI,QAAQ;AACV,oBAAQ,QAAQ,MAAM;AAAA,UACxB;AAAA,QACF;AAAA,MACF,GAAG,YAAY;AAAA,MACf,eAAe,MAAM;AACnB,cAAM,cAAc,QAAQ,QAAQ,GAAG;AAEvC,YAAI,CAAC,aAAa;AAChB;AAAA,QACF;AAEA,eAAO,YAAY,WAAW;AAAA,MAChC;AAAA,MACA,cAAc,MAAM;AAClB,gBAAQ,WAAW,GAAG;AAAA,MACxB;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AAAA,IACL,eAAe;AAAA,IACf,eAAe;AAAA,IACf,cAAc;AAAA,EAChB;AACF;AAEA,SAAS,SACP,MACA,OAAO,KACP;AACA,MAAI,QAA8C;AAClD,MAAI;AACJ,SAAO,YAAa,MAAa;AAC/B,aAAS;AACT,QAAI,UAAU,MAAM;AAClB,cAAQ,WAAW,MAAM;AACvB,aAAK,GAAG,MAAM;AACd,gBAAQ;AAAA,MACV,GAAG,IAAI;AAAA,IACT;AAAA,EACF;AACF;","names":[]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tanstack/query-sync-storage-persister",
|
|
3
|
-
"version": "5.81.
|
|
3
|
+
"version": "5.81.4",
|
|
4
4
|
"description": "A persister for synchronous storages, to be used with TanStack/Query",
|
|
5
5
|
"author": "tannerlinsley",
|
|
6
6
|
"license": "MIT",
|
|
@@ -40,12 +40,30 @@
|
|
|
40
40
|
"!src/__tests__"
|
|
41
41
|
],
|
|
42
42
|
"dependencies": {
|
|
43
|
-
"@tanstack/query-core": "5.81.
|
|
44
|
-
"@tanstack/query-persist-client-core": "5.81.
|
|
43
|
+
"@tanstack/query-core": "5.81.4",
|
|
44
|
+
"@tanstack/query-persist-client-core": "5.81.4"
|
|
45
45
|
},
|
|
46
46
|
"devDependencies": {
|
|
47
47
|
"npm-run-all2": "^5.0.0",
|
|
48
48
|
"@tanstack/query-test-utils": "0.0.0"
|
|
49
49
|
},
|
|
50
|
-
"scripts": {
|
|
50
|
+
"scripts": {
|
|
51
|
+
"clean": "premove ./build ./coverage ./dist-ts",
|
|
52
|
+
"compile": "tsc --build",
|
|
53
|
+
"test:eslint": "eslint ./src",
|
|
54
|
+
"test:types": "npm-run-all --serial test:types:*",
|
|
55
|
+
"test:types:ts50": "node ../../node_modules/typescript50/lib/tsc.js --build",
|
|
56
|
+
"test:types:ts51": "node ../../node_modules/typescript51/lib/tsc.js --build",
|
|
57
|
+
"test:types:ts52": "node ../../node_modules/typescript52/lib/tsc.js --build",
|
|
58
|
+
"test:types:ts53": "node ../../node_modules/typescript53/lib/tsc.js --build",
|
|
59
|
+
"test:types:ts54": "node ../../node_modules/typescript54/lib/tsc.js --build",
|
|
60
|
+
"test:types:ts55": "node ../../node_modules/typescript55/lib/tsc.js --build",
|
|
61
|
+
"test:types:ts56": "node ../../node_modules/typescript56/lib/tsc.js --build",
|
|
62
|
+
"test:types:ts57": "node ../../node_modules/typescript57/lib/tsc.js --build",
|
|
63
|
+
"test:types:tscurrent": "tsc --build",
|
|
64
|
+
"test:lib": "vitest",
|
|
65
|
+
"test:lib:dev": "pnpm run test:lib --watch",
|
|
66
|
+
"test:build": "publint --strict && attw --pack",
|
|
67
|
+
"build": "tsup --tsconfig tsconfig.prod.json"
|
|
68
|
+
}
|
|
51
69
|
}
|
package/src/index.ts
CHANGED
|
@@ -36,6 +36,9 @@ interface CreateSyncStoragePersisterOptions {
|
|
|
36
36
|
retry?: PersistRetryer
|
|
37
37
|
}
|
|
38
38
|
|
|
39
|
+
/**
|
|
40
|
+
* @deprecated use `createAsyncStoragePersister` from `@tanstack/query-async-storage-persister` instead.
|
|
41
|
+
*/
|
|
39
42
|
export function createSyncStoragePersister({
|
|
40
43
|
storage,
|
|
41
44
|
key = `REACT_QUERY_OFFLINE_CACHE`,
|