@tanstack/query-sync-storage-persister 4.24.9 → 5.0.0-alpha.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/lib/index.esm.js +4 -12
- package/build/lib/index.esm.js.map +1 -1
- package/build/lib/index.js +4 -14
- package/build/lib/index.js.map +1 -1
- package/build/lib/index.mjs +4 -12
- package/build/lib/index.mjs.map +1 -1
- package/build/umd/index.development.js +4 -14
- package/build/umd/index.development.js.map +1 -1
- package/build/umd/index.production.js +1 -1
- package/build/umd/index.production.js.map +1 -1
- package/package.json +2 -2
- package/src/__tests__/storageIsFull.test.ts +48 -14
package/build/lib/index.esm.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
function createSyncStoragePersister({
|
|
2
2
|
storage,
|
|
3
|
-
key =
|
|
3
|
+
key = `REACT_QUERY_OFFLINE_CACHE`,
|
|
4
4
|
throttleTime = 1000,
|
|
5
5
|
serialize = JSON.stringify,
|
|
6
6
|
deserialize = JSON.parse,
|
|
@@ -15,21 +15,18 @@ function createSyncStoragePersister({
|
|
|
15
15
|
return error;
|
|
16
16
|
}
|
|
17
17
|
};
|
|
18
|
-
|
|
19
18
|
return {
|
|
20
19
|
persistClient: throttle(persistedClient => {
|
|
21
20
|
let client = persistedClient;
|
|
22
21
|
let error = trySave(client);
|
|
23
22
|
let errorCount = 0;
|
|
24
|
-
|
|
25
23
|
while (error && client) {
|
|
26
24
|
errorCount++;
|
|
27
|
-
client = retry
|
|
25
|
+
client = retry?.({
|
|
28
26
|
persistedClient: client,
|
|
29
27
|
error,
|
|
30
28
|
errorCount
|
|
31
29
|
});
|
|
32
|
-
|
|
33
30
|
if (client) {
|
|
34
31
|
error = trySave(client);
|
|
35
32
|
}
|
|
@@ -37,11 +34,9 @@ function createSyncStoragePersister({
|
|
|
37
34
|
}, throttleTime),
|
|
38
35
|
restoreClient: () => {
|
|
39
36
|
const cacheString = storage.getItem(key);
|
|
40
|
-
|
|
41
37
|
if (!cacheString) {
|
|
42
38
|
return;
|
|
43
39
|
}
|
|
44
|
-
|
|
45
40
|
return deserialize(cacheString);
|
|
46
41
|
},
|
|
47
42
|
removeClient: () => {
|
|
@@ -49,20 +44,17 @@ function createSyncStoragePersister({
|
|
|
49
44
|
}
|
|
50
45
|
};
|
|
51
46
|
}
|
|
52
|
-
|
|
53
47
|
return {
|
|
54
48
|
persistClient: noop,
|
|
55
49
|
restoreClient: () => undefined,
|
|
56
50
|
removeClient: noop
|
|
57
51
|
};
|
|
58
52
|
}
|
|
59
|
-
|
|
60
53
|
function throttle(func, wait = 100) {
|
|
61
54
|
let timer = null;
|
|
62
55
|
let params;
|
|
63
56
|
return function (...args) {
|
|
64
57
|
params = args;
|
|
65
|
-
|
|
66
58
|
if (timer === null) {
|
|
67
59
|
timer = setTimeout(() => {
|
|
68
60
|
func(...params);
|
|
@@ -70,9 +62,9 @@ function throttle(func, wait = 100) {
|
|
|
70
62
|
}, wait);
|
|
71
63
|
}
|
|
72
64
|
};
|
|
73
|
-
}
|
|
74
|
-
|
|
65
|
+
}
|
|
75
66
|
|
|
67
|
+
// eslint-disable-next-line @typescript-eslint/no-empty-function
|
|
76
68
|
function noop() {}
|
|
77
69
|
|
|
78
70
|
export { createSyncStoragePersister };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.esm.js","sources":["../../src/index.ts"],"sourcesContent":["import type {\n PersistedClient,\n Persister,\n PersistRetryer,\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`.\n */\n storage: Storage | 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?: 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 (typeof storage !== 'undefined') {\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) as PersistedClient\n },\n removeClient: () => {\n storage.removeItem(key)\n },\n }\n }\n\n return {\n persistClient: noop,\n restoreClient: () => undefined,\n removeClient: noop,\n }\n}\n\nfunction throttle<TArgs extends 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\n// eslint-disable-next-line @typescript-eslint/no-empty-function\nfunction noop() {}\n"],"names":["createSyncStoragePersister","storage","key","throttleTime","serialize","JSON","stringify","deserialize","parse","retry","trySave","persistedClient","setItem","error","persistClient","throttle","client","errorCount","restoreClient","cacheString","getItem","removeClient","removeItem","noop","undefined","func","wait","timer","params","args","setTimeout"],"mappings":"AAoCO,SAASA,
|
|
1
|
+
{"version":3,"file":"index.esm.js","sources":["../../src/index.ts"],"sourcesContent":["import type {\n PersistedClient,\n Persister,\n PersistRetryer,\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`.\n */\n storage: Storage | 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?: 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 (typeof storage !== 'undefined') {\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) as PersistedClient\n },\n removeClient: () => {\n storage.removeItem(key)\n },\n }\n }\n\n return {\n persistClient: noop,\n restoreClient: () => undefined,\n removeClient: noop,\n }\n}\n\nfunction throttle<TArgs extends 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\n// eslint-disable-next-line @typescript-eslint/no-empty-function\nfunction noop() {}\n"],"names":["createSyncStoragePersister","storage","key","throttleTime","serialize","JSON","stringify","deserialize","parse","retry","trySave","persistedClient","setItem","error","persistClient","throttle","client","errorCount","restoreClient","cacheString","getItem","removeClient","removeItem","noop","undefined","func","wait","timer","params","args","setTimeout"],"mappings":"AAoCO,SAASA,0BAA0B,CAAC;EACzCC,OAAO;AACPC,EAAAA,GAAG,GAAI,CAA0B,yBAAA,CAAA;AACjCC,EAAAA,YAAY,GAAG,IAAI;EACnBC,SAAS,GAAGC,IAAI,CAACC,SAAS;EAC1BC,WAAW,GAAGF,IAAI,CAACG,KAAK;AACxBC,EAAAA,KAAAA;AACiC,CAAC,EAAa;AAC/C,EAAA,IAAI,OAAOR,OAAO,KAAK,WAAW,EAAE;IAClC,MAAMS,OAAO,GAAIC,eAAgC,IAAwB;MACvE,IAAI;QACFV,OAAO,CAACW,OAAO,CAACV,GAAG,EAAEE,SAAS,CAACO,eAAe,CAAC,CAAC,CAAA;AAChD,QAAA,OAAA;OACD,CAAC,OAAOE,KAAK,EAAE;AACd,QAAA,OAAOA,KAAK,CAAA;AACd,OAAA;KACD,CAAA;IACD,OAAO;AACLC,MAAAA,aAAa,EAAEC,QAAQ,CAAEJ,eAAe,IAAK;QAC3C,IAAIK,MAAmC,GAAGL,eAAe,CAAA;AACzD,QAAA,IAAIE,KAAK,GAAGH,OAAO,CAACM,MAAM,CAAC,CAAA;QAC3B,IAAIC,UAAU,GAAG,CAAC,CAAA;QAClB,OAAOJ,KAAK,IAAIG,MAAM,EAAE;AACtBC,UAAAA,UAAU,EAAE,CAAA;UACZD,MAAM,GAAGP,KAAK,GAAG;AACfE,YAAAA,eAAe,EAAEK,MAAM;YACvBH,KAAK;AACLI,YAAAA,UAAAA;AACF,WAAC,CAAC,CAAA;AAEF,UAAA,IAAID,MAAM,EAAE;AACVH,YAAAA,KAAK,GAAGH,OAAO,CAACM,MAAM,CAAC,CAAA;AACzB,WAAA;AACF,SAAA;OACD,EAAEb,YAAY,CAAC;AAChBe,MAAAA,aAAa,EAAE,MAAM;AACnB,QAAA,MAAMC,WAAW,GAAGlB,OAAO,CAACmB,OAAO,CAAClB,GAAG,CAAC,CAAA;QAExC,IAAI,CAACiB,WAAW,EAAE;AAChB,UAAA,OAAA;AACF,SAAA;QAEA,OAAOZ,WAAW,CAACY,WAAW,CAAC,CAAA;OAChC;AACDE,MAAAA,YAAY,EAAE,MAAM;AAClBpB,QAAAA,OAAO,CAACqB,UAAU,CAACpB,GAAG,CAAC,CAAA;AACzB,OAAA;KACD,CAAA;AACH,GAAA;EAEA,OAAO;AACLY,IAAAA,aAAa,EAAES,IAAI;IACnBL,aAAa,EAAE,MAAMM,SAAS;AAC9BH,IAAAA,YAAY,EAAEE,IAAAA;GACf,CAAA;AACH,CAAA;AAEA,SAASR,QAAQ,CACfU,IAA6B,EAC7BC,IAAI,GAAG,GAAG,EACV;EACA,IAAIC,KAA2C,GAAG,IAAI,CAAA;AACtD,EAAA,IAAIC,MAAa,CAAA;EACjB,OAAO,UAAU,GAAGC,IAAW,EAAE;AAC/BD,IAAAA,MAAM,GAAGC,IAAI,CAAA;IACb,IAAIF,KAAK,KAAK,IAAI,EAAE;MAClBA,KAAK,GAAGG,UAAU,CAAC,MAAM;QACvBL,IAAI,CAAC,GAAGG,MAAM,CAAC,CAAA;AACfD,QAAAA,KAAK,GAAG,IAAI,CAAA;OACb,EAAED,IAAI,CAAC,CAAA;AACV,KAAA;GACD,CAAA;AACH,CAAA;;AAEA;AACA,SAASH,IAAI,GAAG;;;;"}
|
package/build/lib/index.js
CHANGED
|
@@ -1,10 +1,8 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
|
-
|
|
5
3
|
function createSyncStoragePersister({
|
|
6
4
|
storage,
|
|
7
|
-
key =
|
|
5
|
+
key = `REACT_QUERY_OFFLINE_CACHE`,
|
|
8
6
|
throttleTime = 1000,
|
|
9
7
|
serialize = JSON.stringify,
|
|
10
8
|
deserialize = JSON.parse,
|
|
@@ -19,21 +17,18 @@ function createSyncStoragePersister({
|
|
|
19
17
|
return error;
|
|
20
18
|
}
|
|
21
19
|
};
|
|
22
|
-
|
|
23
20
|
return {
|
|
24
21
|
persistClient: throttle(persistedClient => {
|
|
25
22
|
let client = persistedClient;
|
|
26
23
|
let error = trySave(client);
|
|
27
24
|
let errorCount = 0;
|
|
28
|
-
|
|
29
25
|
while (error && client) {
|
|
30
26
|
errorCount++;
|
|
31
|
-
client = retry
|
|
27
|
+
client = retry?.({
|
|
32
28
|
persistedClient: client,
|
|
33
29
|
error,
|
|
34
30
|
errorCount
|
|
35
31
|
});
|
|
36
|
-
|
|
37
32
|
if (client) {
|
|
38
33
|
error = trySave(client);
|
|
39
34
|
}
|
|
@@ -41,11 +36,9 @@ function createSyncStoragePersister({
|
|
|
41
36
|
}, throttleTime),
|
|
42
37
|
restoreClient: () => {
|
|
43
38
|
const cacheString = storage.getItem(key);
|
|
44
|
-
|
|
45
39
|
if (!cacheString) {
|
|
46
40
|
return;
|
|
47
41
|
}
|
|
48
|
-
|
|
49
42
|
return deserialize(cacheString);
|
|
50
43
|
},
|
|
51
44
|
removeClient: () => {
|
|
@@ -53,20 +46,17 @@ function createSyncStoragePersister({
|
|
|
53
46
|
}
|
|
54
47
|
};
|
|
55
48
|
}
|
|
56
|
-
|
|
57
49
|
return {
|
|
58
50
|
persistClient: noop,
|
|
59
51
|
restoreClient: () => undefined,
|
|
60
52
|
removeClient: noop
|
|
61
53
|
};
|
|
62
54
|
}
|
|
63
|
-
|
|
64
55
|
function throttle(func, wait = 100) {
|
|
65
56
|
let timer = null;
|
|
66
57
|
let params;
|
|
67
58
|
return function (...args) {
|
|
68
59
|
params = args;
|
|
69
|
-
|
|
70
60
|
if (timer === null) {
|
|
71
61
|
timer = setTimeout(() => {
|
|
72
62
|
func(...params);
|
|
@@ -74,9 +64,9 @@ function throttle(func, wait = 100) {
|
|
|
74
64
|
}, wait);
|
|
75
65
|
}
|
|
76
66
|
};
|
|
77
|
-
}
|
|
78
|
-
|
|
67
|
+
}
|
|
79
68
|
|
|
69
|
+
// eslint-disable-next-line @typescript-eslint/no-empty-function
|
|
80
70
|
function noop() {}
|
|
81
71
|
|
|
82
72
|
exports.createSyncStoragePersister = createSyncStoragePersister;
|
package/build/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sources":["../../src/index.ts"],"sourcesContent":["import type {\n PersistedClient,\n Persister,\n PersistRetryer,\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`.\n */\n storage: Storage | 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?: 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 (typeof storage !== 'undefined') {\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) as PersistedClient\n },\n removeClient: () => {\n storage.removeItem(key)\n },\n }\n }\n\n return {\n persistClient: noop,\n restoreClient: () => undefined,\n removeClient: noop,\n }\n}\n\nfunction throttle<TArgs extends 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\n// eslint-disable-next-line @typescript-eslint/no-empty-function\nfunction noop() {}\n"],"names":["createSyncStoragePersister","storage","key","throttleTime","serialize","JSON","stringify","deserialize","parse","retry","trySave","persistedClient","setItem","error","persistClient","throttle","client","errorCount","restoreClient","cacheString","getItem","removeClient","removeItem","noop","undefined","func","wait","timer","params","args","setTimeout"],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sources":["../../src/index.ts"],"sourcesContent":["import type {\n PersistedClient,\n Persister,\n PersistRetryer,\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`.\n */\n storage: Storage | 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?: 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 (typeof storage !== 'undefined') {\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) as PersistedClient\n },\n removeClient: () => {\n storage.removeItem(key)\n },\n }\n }\n\n return {\n persistClient: noop,\n restoreClient: () => undefined,\n removeClient: noop,\n }\n}\n\nfunction throttle<TArgs extends 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\n// eslint-disable-next-line @typescript-eslint/no-empty-function\nfunction noop() {}\n"],"names":["createSyncStoragePersister","storage","key","throttleTime","serialize","JSON","stringify","deserialize","parse","retry","trySave","persistedClient","setItem","error","persistClient","throttle","client","errorCount","restoreClient","cacheString","getItem","removeClient","removeItem","noop","undefined","func","wait","timer","params","args","setTimeout"],"mappings":";;AAoCO,SAASA,0BAA0B,CAAC;EACzCC,OAAO;AACPC,EAAAA,GAAG,GAAI,CAA0B,yBAAA,CAAA;AACjCC,EAAAA,YAAY,GAAG,IAAI;EACnBC,SAAS,GAAGC,IAAI,CAACC,SAAS;EAC1BC,WAAW,GAAGF,IAAI,CAACG,KAAK;AACxBC,EAAAA,KAAAA;AACiC,CAAC,EAAa;AAC/C,EAAA,IAAI,OAAOR,OAAO,KAAK,WAAW,EAAE;IAClC,MAAMS,OAAO,GAAIC,eAAgC,IAAwB;MACvE,IAAI;QACFV,OAAO,CAACW,OAAO,CAACV,GAAG,EAAEE,SAAS,CAACO,eAAe,CAAC,CAAC,CAAA;AAChD,QAAA,OAAA;OACD,CAAC,OAAOE,KAAK,EAAE;AACd,QAAA,OAAOA,KAAK,CAAA;AACd,OAAA;KACD,CAAA;IACD,OAAO;AACLC,MAAAA,aAAa,EAAEC,QAAQ,CAAEJ,eAAe,IAAK;QAC3C,IAAIK,MAAmC,GAAGL,eAAe,CAAA;AACzD,QAAA,IAAIE,KAAK,GAAGH,OAAO,CAACM,MAAM,CAAC,CAAA;QAC3B,IAAIC,UAAU,GAAG,CAAC,CAAA;QAClB,OAAOJ,KAAK,IAAIG,MAAM,EAAE;AACtBC,UAAAA,UAAU,EAAE,CAAA;UACZD,MAAM,GAAGP,KAAK,GAAG;AACfE,YAAAA,eAAe,EAAEK,MAAM;YACvBH,KAAK;AACLI,YAAAA,UAAAA;AACF,WAAC,CAAC,CAAA;AAEF,UAAA,IAAID,MAAM,EAAE;AACVH,YAAAA,KAAK,GAAGH,OAAO,CAACM,MAAM,CAAC,CAAA;AACzB,WAAA;AACF,SAAA;OACD,EAAEb,YAAY,CAAC;AAChBe,MAAAA,aAAa,EAAE,MAAM;AACnB,QAAA,MAAMC,WAAW,GAAGlB,OAAO,CAACmB,OAAO,CAAClB,GAAG,CAAC,CAAA;QAExC,IAAI,CAACiB,WAAW,EAAE;AAChB,UAAA,OAAA;AACF,SAAA;QAEA,OAAOZ,WAAW,CAACY,WAAW,CAAC,CAAA;OAChC;AACDE,MAAAA,YAAY,EAAE,MAAM;AAClBpB,QAAAA,OAAO,CAACqB,UAAU,CAACpB,GAAG,CAAC,CAAA;AACzB,OAAA;KACD,CAAA;AACH,GAAA;EAEA,OAAO;AACLY,IAAAA,aAAa,EAAES,IAAI;IACnBL,aAAa,EAAE,MAAMM,SAAS;AAC9BH,IAAAA,YAAY,EAAEE,IAAAA;GACf,CAAA;AACH,CAAA;AAEA,SAASR,QAAQ,CACfU,IAA6B,EAC7BC,IAAI,GAAG,GAAG,EACV;EACA,IAAIC,KAA2C,GAAG,IAAI,CAAA;AACtD,EAAA,IAAIC,MAAa,CAAA;EACjB,OAAO,UAAU,GAAGC,IAAW,EAAE;AAC/BD,IAAAA,MAAM,GAAGC,IAAI,CAAA;IACb,IAAIF,KAAK,KAAK,IAAI,EAAE;MAClBA,KAAK,GAAGG,UAAU,CAAC,MAAM;QACvBL,IAAI,CAAC,GAAGG,MAAM,CAAC,CAAA;AACfD,QAAAA,KAAK,GAAG,IAAI,CAAA;OACb,EAAED,IAAI,CAAC,CAAA;AACV,KAAA;GACD,CAAA;AACH,CAAA;;AAEA;AACA,SAASH,IAAI,GAAG;;;;"}
|
package/build/lib/index.mjs
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
function createSyncStoragePersister({
|
|
2
2
|
storage,
|
|
3
|
-
key =
|
|
3
|
+
key = `REACT_QUERY_OFFLINE_CACHE`,
|
|
4
4
|
throttleTime = 1000,
|
|
5
5
|
serialize = JSON.stringify,
|
|
6
6
|
deserialize = JSON.parse,
|
|
@@ -15,21 +15,18 @@ function createSyncStoragePersister({
|
|
|
15
15
|
return error;
|
|
16
16
|
}
|
|
17
17
|
};
|
|
18
|
-
|
|
19
18
|
return {
|
|
20
19
|
persistClient: throttle(persistedClient => {
|
|
21
20
|
let client = persistedClient;
|
|
22
21
|
let error = trySave(client);
|
|
23
22
|
let errorCount = 0;
|
|
24
|
-
|
|
25
23
|
while (error && client) {
|
|
26
24
|
errorCount++;
|
|
27
|
-
client = retry
|
|
25
|
+
client = retry?.({
|
|
28
26
|
persistedClient: client,
|
|
29
27
|
error,
|
|
30
28
|
errorCount
|
|
31
29
|
});
|
|
32
|
-
|
|
33
30
|
if (client) {
|
|
34
31
|
error = trySave(client);
|
|
35
32
|
}
|
|
@@ -37,11 +34,9 @@ function createSyncStoragePersister({
|
|
|
37
34
|
}, throttleTime),
|
|
38
35
|
restoreClient: () => {
|
|
39
36
|
const cacheString = storage.getItem(key);
|
|
40
|
-
|
|
41
37
|
if (!cacheString) {
|
|
42
38
|
return;
|
|
43
39
|
}
|
|
44
|
-
|
|
45
40
|
return deserialize(cacheString);
|
|
46
41
|
},
|
|
47
42
|
removeClient: () => {
|
|
@@ -49,20 +44,17 @@ function createSyncStoragePersister({
|
|
|
49
44
|
}
|
|
50
45
|
};
|
|
51
46
|
}
|
|
52
|
-
|
|
53
47
|
return {
|
|
54
48
|
persistClient: noop,
|
|
55
49
|
restoreClient: () => undefined,
|
|
56
50
|
removeClient: noop
|
|
57
51
|
};
|
|
58
52
|
}
|
|
59
|
-
|
|
60
53
|
function throttle(func, wait = 100) {
|
|
61
54
|
let timer = null;
|
|
62
55
|
let params;
|
|
63
56
|
return function (...args) {
|
|
64
57
|
params = args;
|
|
65
|
-
|
|
66
58
|
if (timer === null) {
|
|
67
59
|
timer = setTimeout(() => {
|
|
68
60
|
func(...params);
|
|
@@ -70,9 +62,9 @@ function throttle(func, wait = 100) {
|
|
|
70
62
|
}, wait);
|
|
71
63
|
}
|
|
72
64
|
};
|
|
73
|
-
}
|
|
74
|
-
|
|
65
|
+
}
|
|
75
66
|
|
|
67
|
+
// eslint-disable-next-line @typescript-eslint/no-empty-function
|
|
76
68
|
function noop() {}
|
|
77
69
|
|
|
78
70
|
export { createSyncStoragePersister };
|
package/build/lib/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sources":["../../src/index.ts"],"sourcesContent":["import type {\n PersistedClient,\n Persister,\n PersistRetryer,\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`.\n */\n storage: Storage | 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?: 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 (typeof storage !== 'undefined') {\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) as PersistedClient\n },\n removeClient: () => {\n storage.removeItem(key)\n },\n }\n }\n\n return {\n persistClient: noop,\n restoreClient: () => undefined,\n removeClient: noop,\n }\n}\n\nfunction throttle<TArgs extends 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\n// eslint-disable-next-line @typescript-eslint/no-empty-function\nfunction noop() {}\n"],"names":["createSyncStoragePersister","storage","key","throttleTime","serialize","JSON","stringify","deserialize","parse","retry","trySave","persistedClient","setItem","error","persistClient","throttle","client","errorCount","restoreClient","cacheString","getItem","removeClient","removeItem","noop","undefined","func","wait","timer","params","args","setTimeout"],"mappings":"AAoCO,SAASA,
|
|
1
|
+
{"version":3,"file":"index.mjs","sources":["../../src/index.ts"],"sourcesContent":["import type {\n PersistedClient,\n Persister,\n PersistRetryer,\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`.\n */\n storage: Storage | 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?: 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 (typeof storage !== 'undefined') {\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) as PersistedClient\n },\n removeClient: () => {\n storage.removeItem(key)\n },\n }\n }\n\n return {\n persistClient: noop,\n restoreClient: () => undefined,\n removeClient: noop,\n }\n}\n\nfunction throttle<TArgs extends 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\n// eslint-disable-next-line @typescript-eslint/no-empty-function\nfunction noop() {}\n"],"names":["createSyncStoragePersister","storage","key","throttleTime","serialize","JSON","stringify","deserialize","parse","retry","trySave","persistedClient","setItem","error","persistClient","throttle","client","errorCount","restoreClient","cacheString","getItem","removeClient","removeItem","noop","undefined","func","wait","timer","params","args","setTimeout"],"mappings":"AAoCO,SAASA,0BAA0B,CAAC;EACzCC,OAAO;AACPC,EAAAA,GAAG,GAAI,CAA0B,yBAAA,CAAA;AACjCC,EAAAA,YAAY,GAAG,IAAI;EACnBC,SAAS,GAAGC,IAAI,CAACC,SAAS;EAC1BC,WAAW,GAAGF,IAAI,CAACG,KAAK;AACxBC,EAAAA,KAAAA;AACiC,CAAC,EAAa;AAC/C,EAAA,IAAI,OAAOR,OAAO,KAAK,WAAW,EAAE;IAClC,MAAMS,OAAO,GAAIC,eAAgC,IAAwB;MACvE,IAAI;QACFV,OAAO,CAACW,OAAO,CAACV,GAAG,EAAEE,SAAS,CAACO,eAAe,CAAC,CAAC,CAAA;AAChD,QAAA,OAAA;OACD,CAAC,OAAOE,KAAK,EAAE;AACd,QAAA,OAAOA,KAAK,CAAA;AACd,OAAA;KACD,CAAA;IACD,OAAO;AACLC,MAAAA,aAAa,EAAEC,QAAQ,CAAEJ,eAAe,IAAK;QAC3C,IAAIK,MAAmC,GAAGL,eAAe,CAAA;AACzD,QAAA,IAAIE,KAAK,GAAGH,OAAO,CAACM,MAAM,CAAC,CAAA;QAC3B,IAAIC,UAAU,GAAG,CAAC,CAAA;QAClB,OAAOJ,KAAK,IAAIG,MAAM,EAAE;AACtBC,UAAAA,UAAU,EAAE,CAAA;UACZD,MAAM,GAAGP,KAAK,GAAG;AACfE,YAAAA,eAAe,EAAEK,MAAM;YACvBH,KAAK;AACLI,YAAAA,UAAAA;AACF,WAAC,CAAC,CAAA;AAEF,UAAA,IAAID,MAAM,EAAE;AACVH,YAAAA,KAAK,GAAGH,OAAO,CAACM,MAAM,CAAC,CAAA;AACzB,WAAA;AACF,SAAA;OACD,EAAEb,YAAY,CAAC;AAChBe,MAAAA,aAAa,EAAE,MAAM;AACnB,QAAA,MAAMC,WAAW,GAAGlB,OAAO,CAACmB,OAAO,CAAClB,GAAG,CAAC,CAAA;QAExC,IAAI,CAACiB,WAAW,EAAE;AAChB,UAAA,OAAA;AACF,SAAA;QAEA,OAAOZ,WAAW,CAACY,WAAW,CAAC,CAAA;OAChC;AACDE,MAAAA,YAAY,EAAE,MAAM;AAClBpB,QAAAA,OAAO,CAACqB,UAAU,CAACpB,GAAG,CAAC,CAAA;AACzB,OAAA;KACD,CAAA;AACH,GAAA;EAEA,OAAO;AACLY,IAAAA,aAAa,EAAES,IAAI;IACnBL,aAAa,EAAE,MAAMM,SAAS;AAC9BH,IAAAA,YAAY,EAAEE,IAAAA;GACf,CAAA;AACH,CAAA;AAEA,SAASR,QAAQ,CACfU,IAA6B,EAC7BC,IAAI,GAAG,GAAG,EACV;EACA,IAAIC,KAA2C,GAAG,IAAI,CAAA;AACtD,EAAA,IAAIC,MAAa,CAAA;EACjB,OAAO,UAAU,GAAGC,IAAW,EAAE;AAC/BD,IAAAA,MAAM,GAAGC,IAAI,CAAA;IACb,IAAIF,KAAK,KAAK,IAAI,EAAE;MAClBA,KAAK,GAAGG,UAAU,CAAC,MAAM;QACvBL,IAAI,CAAC,GAAGG,MAAM,CAAC,CAAA;AACfD,QAAAA,KAAK,GAAG,IAAI,CAAA;OACb,EAAED,IAAI,CAAC,CAAA;AACV,KAAA;GACD,CAAA;AACH,CAAA;;AAEA;AACA,SAASH,IAAI,GAAG;;;;"}
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
function createSyncStoragePersister({
|
|
8
8
|
storage,
|
|
9
|
-
key =
|
|
9
|
+
key = `REACT_QUERY_OFFLINE_CACHE`,
|
|
10
10
|
throttleTime = 1000,
|
|
11
11
|
serialize = JSON.stringify,
|
|
12
12
|
deserialize = JSON.parse,
|
|
@@ -21,21 +21,18 @@
|
|
|
21
21
|
return error;
|
|
22
22
|
}
|
|
23
23
|
};
|
|
24
|
-
|
|
25
24
|
return {
|
|
26
25
|
persistClient: throttle(persistedClient => {
|
|
27
26
|
let client = persistedClient;
|
|
28
27
|
let error = trySave(client);
|
|
29
28
|
let errorCount = 0;
|
|
30
|
-
|
|
31
29
|
while (error && client) {
|
|
32
30
|
errorCount++;
|
|
33
|
-
client = retry
|
|
31
|
+
client = retry?.({
|
|
34
32
|
persistedClient: client,
|
|
35
33
|
error,
|
|
36
34
|
errorCount
|
|
37
35
|
});
|
|
38
|
-
|
|
39
36
|
if (client) {
|
|
40
37
|
error = trySave(client);
|
|
41
38
|
}
|
|
@@ -43,11 +40,9 @@
|
|
|
43
40
|
}, throttleTime),
|
|
44
41
|
restoreClient: () => {
|
|
45
42
|
const cacheString = storage.getItem(key);
|
|
46
|
-
|
|
47
43
|
if (!cacheString) {
|
|
48
44
|
return;
|
|
49
45
|
}
|
|
50
|
-
|
|
51
46
|
return deserialize(cacheString);
|
|
52
47
|
},
|
|
53
48
|
removeClient: () => {
|
|
@@ -55,20 +50,17 @@
|
|
|
55
50
|
}
|
|
56
51
|
};
|
|
57
52
|
}
|
|
58
|
-
|
|
59
53
|
return {
|
|
60
54
|
persistClient: noop,
|
|
61
55
|
restoreClient: () => undefined,
|
|
62
56
|
removeClient: noop
|
|
63
57
|
};
|
|
64
58
|
}
|
|
65
|
-
|
|
66
59
|
function throttle(func, wait = 100) {
|
|
67
60
|
let timer = null;
|
|
68
61
|
let params;
|
|
69
62
|
return function (...args) {
|
|
70
63
|
params = args;
|
|
71
|
-
|
|
72
64
|
if (timer === null) {
|
|
73
65
|
timer = setTimeout(() => {
|
|
74
66
|
func(...params);
|
|
@@ -76,14 +68,12 @@
|
|
|
76
68
|
}, wait);
|
|
77
69
|
}
|
|
78
70
|
};
|
|
79
|
-
}
|
|
80
|
-
|
|
71
|
+
}
|
|
81
72
|
|
|
73
|
+
// eslint-disable-next-line @typescript-eslint/no-empty-function
|
|
82
74
|
function noop() {}
|
|
83
75
|
|
|
84
76
|
exports.createSyncStoragePersister = createSyncStoragePersister;
|
|
85
77
|
|
|
86
|
-
Object.defineProperty(exports, '__esModule', { value: true });
|
|
87
|
-
|
|
88
78
|
}));
|
|
89
79
|
//# sourceMappingURL=index.development.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.development.js","sources":["../../src/index.ts"],"sourcesContent":["import type {\n PersistedClient,\n Persister,\n PersistRetryer,\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`.\n */\n storage: Storage | 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?: 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 (typeof storage !== 'undefined') {\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) as PersistedClient\n },\n removeClient: () => {\n storage.removeItem(key)\n },\n }\n }\n\n return {\n persistClient: noop,\n restoreClient: () => undefined,\n removeClient: noop,\n }\n}\n\nfunction throttle<TArgs extends 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\n// eslint-disable-next-line @typescript-eslint/no-empty-function\nfunction noop() {}\n"],"names":["createSyncStoragePersister","storage","key","throttleTime","serialize","JSON","stringify","deserialize","parse","retry","trySave","persistedClient","setItem","error","persistClient","throttle","client","errorCount","restoreClient","cacheString","getItem","removeClient","removeItem","noop","undefined","func","wait","timer","params","args","setTimeout"],"mappings":";;;;;;EAoCO,SAASA,
|
|
1
|
+
{"version":3,"file":"index.development.js","sources":["../../src/index.ts"],"sourcesContent":["import type {\n PersistedClient,\n Persister,\n PersistRetryer,\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`.\n */\n storage: Storage | 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?: 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 (typeof storage !== 'undefined') {\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) as PersistedClient\n },\n removeClient: () => {\n storage.removeItem(key)\n },\n }\n }\n\n return {\n persistClient: noop,\n restoreClient: () => undefined,\n removeClient: noop,\n }\n}\n\nfunction throttle<TArgs extends 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\n// eslint-disable-next-line @typescript-eslint/no-empty-function\nfunction noop() {}\n"],"names":["createSyncStoragePersister","storage","key","throttleTime","serialize","JSON","stringify","deserialize","parse","retry","trySave","persistedClient","setItem","error","persistClient","throttle","client","errorCount","restoreClient","cacheString","getItem","removeClient","removeItem","noop","undefined","func","wait","timer","params","args","setTimeout"],"mappings":";;;;;;EAoCO,SAASA,0BAA0B,CAAC;IACzCC,OAAO;EACPC,EAAAA,GAAG,GAAI,CAA0B,yBAAA,CAAA;EACjCC,EAAAA,YAAY,GAAG,IAAI;IACnBC,SAAS,GAAGC,IAAI,CAACC,SAAS;IAC1BC,WAAW,GAAGF,IAAI,CAACG,KAAK;EACxBC,EAAAA,KAAAA;EACiC,CAAC,EAAa;EAC/C,EAAA,IAAI,OAAOR,OAAO,KAAK,WAAW,EAAE;MAClC,MAAMS,OAAO,GAAIC,eAAgC,IAAwB;QACvE,IAAI;UACFV,OAAO,CAACW,OAAO,CAACV,GAAG,EAAEE,SAAS,CAACO,eAAe,CAAC,CAAC,CAAA;EAChD,QAAA,OAAA;SACD,CAAC,OAAOE,KAAK,EAAE;EACd,QAAA,OAAOA,KAAK,CAAA;EACd,OAAA;OACD,CAAA;MACD,OAAO;EACLC,MAAAA,aAAa,EAAEC,QAAQ,CAAEJ,eAAe,IAAK;UAC3C,IAAIK,MAAmC,GAAGL,eAAe,CAAA;EACzD,QAAA,IAAIE,KAAK,GAAGH,OAAO,CAACM,MAAM,CAAC,CAAA;UAC3B,IAAIC,UAAU,GAAG,CAAC,CAAA;UAClB,OAAOJ,KAAK,IAAIG,MAAM,EAAE;EACtBC,UAAAA,UAAU,EAAE,CAAA;YACZD,MAAM,GAAGP,KAAK,GAAG;EACfE,YAAAA,eAAe,EAAEK,MAAM;cACvBH,KAAK;EACLI,YAAAA,UAAAA;EACF,WAAC,CAAC,CAAA;EAEF,UAAA,IAAID,MAAM,EAAE;EACVH,YAAAA,KAAK,GAAGH,OAAO,CAACM,MAAM,CAAC,CAAA;EACzB,WAAA;EACF,SAAA;SACD,EAAEb,YAAY,CAAC;EAChBe,MAAAA,aAAa,EAAE,MAAM;EACnB,QAAA,MAAMC,WAAW,GAAGlB,OAAO,CAACmB,OAAO,CAAClB,GAAG,CAAC,CAAA;UAExC,IAAI,CAACiB,WAAW,EAAE;EAChB,UAAA,OAAA;EACF,SAAA;UAEA,OAAOZ,WAAW,CAACY,WAAW,CAAC,CAAA;SAChC;EACDE,MAAAA,YAAY,EAAE,MAAM;EAClBpB,QAAAA,OAAO,CAACqB,UAAU,CAACpB,GAAG,CAAC,CAAA;EACzB,OAAA;OACD,CAAA;EACH,GAAA;IAEA,OAAO;EACLY,IAAAA,aAAa,EAAES,IAAI;MACnBL,aAAa,EAAE,MAAMM,SAAS;EAC9BH,IAAAA,YAAY,EAAEE,IAAAA;KACf,CAAA;EACH,CAAA;EAEA,SAASR,QAAQ,CACfU,IAA6B,EAC7BC,IAAI,GAAG,GAAG,EACV;IACA,IAAIC,KAA2C,GAAG,IAAI,CAAA;EACtD,EAAA,IAAIC,MAAa,CAAA;IACjB,OAAO,UAAU,GAAGC,IAAW,EAAE;EAC/BD,IAAAA,MAAM,GAAGC,IAAI,CAAA;MACb,IAAIF,KAAK,KAAK,IAAI,EAAE;QAClBA,KAAK,GAAGG,UAAU,CAAC,MAAM;UACvBL,IAAI,CAAC,GAAGG,MAAM,CAAC,CAAA;EACfD,QAAAA,KAAK,GAAG,IAAI,CAAA;SACb,EAAED,IAAI,CAAC,CAAA;EACV,KAAA;KACD,CAAA;EACH,CAAA;;EAEA;EACA,SAASH,IAAI,GAAG;;;;;;;;"}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
!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).QuerySyncStoragePersister={})}(this,(function(e){"use strict";function t(e,t=100){let r,n=null;return function(...i){r=i,null===n&&(n=setTimeout((()=>{e(...r),n=null}),t))}}function r(){}e.createSyncStoragePersister=function({storage:e,key:n="REACT_QUERY_OFFLINE_CACHE",throttleTime:i=1e3,serialize:o=JSON.stringify,deserialize:s=JSON.parse,retry:l}){if(void 0!==e){const r=t=>{try{return void e.setItem(n,o(t))}catch(e){return e}};return{persistClient:t((e=>{let t=e,n=r(t),i=0;for(;n&&t;)i++,t=
|
|
1
|
+
!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).QuerySyncStoragePersister={})}(this,(function(e){"use strict";function t(e,t=100){let r,n=null;return function(...i){r=i,null===n&&(n=setTimeout((()=>{e(...r),n=null}),t))}}function r(){}e.createSyncStoragePersister=function({storage:e,key:n="REACT_QUERY_OFFLINE_CACHE",throttleTime:i=1e3,serialize:o=JSON.stringify,deserialize:s=JSON.parse,retry:l}){if(void 0!==e){const r=t=>{try{return void e.setItem(n,o(t))}catch(e){return e}};return{persistClient:t((e=>{let t=e,n=r(t),i=0;for(;n&&t;)i++,t=l?.({persistedClient:t,error:n,errorCount:i}),t&&(n=r(t))}),i),restoreClient:()=>{const t=e.getItem(n);if(t)return s(t)},removeClient:()=>{e.removeItem(n)}}}return{persistClient:r,restoreClient:()=>{},removeClient:r}}}));
|
|
2
2
|
//# sourceMappingURL=index.production.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.production.js","sources":["../../src/index.ts"],"sourcesContent":["import type {\n PersistedClient,\n Persister,\n PersistRetryer,\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`.\n */\n storage: Storage | 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?: 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 (typeof storage !== 'undefined') {\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) as PersistedClient\n },\n removeClient: () => {\n storage.removeItem(key)\n },\n }\n }\n\n return {\n persistClient: noop,\n restoreClient: () => undefined,\n removeClient: noop,\n }\n}\n\nfunction throttle<TArgs extends 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\n// eslint-disable-next-line @typescript-eslint/no-empty-function\nfunction noop() {}\n"],"names":["throttle","func","wait","params","timer","args","setTimeout","noop","storage","key","throttleTime","serialize","JSON","stringify","deserialize","parse","retry","trySave","persistedClient","setItem","error","persistClient","client","errorCount","restoreClient","cacheString","getItem","removeClient","removeItem"],"mappings":"iQA6FA,SAASA,EACPC,EACAC,EAAO,KAEP,IACIC,EADAC,EAA8C,KAElD,OAAO,YAAaC,GAClBF,EAASE,EACK,OAAVD,IACFA,EAAQE,YAAW,KACjBL,KAAQE,GACRC,EAAQ,OACPF,KAMT,SAASK,kCA3EF,UAAoCC,QACzCA,
|
|
1
|
+
{"version":3,"file":"index.production.js","sources":["../../src/index.ts"],"sourcesContent":["import type {\n PersistedClient,\n Persister,\n PersistRetryer,\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`.\n */\n storage: Storage | 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?: 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 (typeof storage !== 'undefined') {\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) as PersistedClient\n },\n removeClient: () => {\n storage.removeItem(key)\n },\n }\n }\n\n return {\n persistClient: noop,\n restoreClient: () => undefined,\n removeClient: noop,\n }\n}\n\nfunction throttle<TArgs extends 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\n// eslint-disable-next-line @typescript-eslint/no-empty-function\nfunction noop() {}\n"],"names":["throttle","func","wait","params","timer","args","setTimeout","noop","storage","key","throttleTime","serialize","JSON","stringify","deserialize","parse","retry","trySave","persistedClient","setItem","error","persistClient","client","errorCount","restoreClient","cacheString","getItem","removeClient","removeItem"],"mappings":"iQA6FA,SAASA,EACPC,EACAC,EAAO,KAEP,IACIC,EADAC,EAA8C,KAElD,OAAO,YAAaC,GAClBF,EAASE,EACK,OAAVD,IACFA,EAAQE,YAAW,KACjBL,KAAQE,GACRC,EAAQ,OACPF,KAMT,SAASK,kCA3EF,UAAoCC,QACzCA,EAAOC,IACPA,EAAO,4BAA0BC,aACjCA,EAAe,IAAIC,UACnBA,EAAYC,KAAKC,UAASC,YAC1BA,EAAcF,KAAKG,MAAKC,MACxBA,IAEA,QAAuB,IAAZR,EAAyB,CAClC,MAAMS,EAAWC,IACf,IAEE,YADAV,EAAQW,QAAQV,EAAKE,EAAUO,IAE/B,MAAOE,GACP,OAAOA,IAGX,MAAO,CACLC,cAAerB,GAAUkB,IACvB,IAAII,EAAsCJ,EACtCE,EAAQH,EAAQK,GAChBC,EAAa,EACjB,KAAOH,GAASE,GACdC,IACAD,EAASN,IAAQ,CACfE,gBAAiBI,EACjBF,QACAG,eAGED,IACFF,EAAQH,EAAQK,MAGnBZ,GACHc,cAAe,KACb,MAAMC,EAAcjB,EAAQkB,QAAQjB,GAEpC,GAAKgB,EAIL,OAAOX,EAAYW,IAErBE,aAAc,KACZnB,EAAQoB,WAAWnB,KAKzB,MAAO,CACLY,cAAed,EACfiB,cAAe,OACfG,aAAcpB"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tanstack/query-sync-storage-persister",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "5.0.0-alpha.0",
|
|
4
4
|
"description": "A persister for synchronous storages, to be used with TanStack/Query",
|
|
5
5
|
"author": "tannerlinsley",
|
|
6
6
|
"license": "MIT",
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
"src"
|
|
29
29
|
],
|
|
30
30
|
"dependencies": {
|
|
31
|
-
"@tanstack/query-persist-client-core": "
|
|
31
|
+
"@tanstack/query-persist-client-core": "5.0.0-alpha.0"
|
|
32
32
|
},
|
|
33
33
|
"scripts": {
|
|
34
34
|
"clean": "rimraf ./build",
|
|
@@ -51,13 +51,26 @@ describe('createpersister ', () => {
|
|
|
51
51
|
storage,
|
|
52
52
|
})
|
|
53
53
|
|
|
54
|
-
await queryClient.prefetchQuery(
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
await queryClient.prefetchQuery(
|
|
59
|
-
|
|
60
|
-
|
|
54
|
+
await queryClient.prefetchQuery({
|
|
55
|
+
queryKey: ['string'],
|
|
56
|
+
queryFn: () => Promise.resolve('string'),
|
|
57
|
+
})
|
|
58
|
+
await queryClient.prefetchQuery({
|
|
59
|
+
queryKey: ['number'],
|
|
60
|
+
queryFn: () => Promise.resolve(1),
|
|
61
|
+
})
|
|
62
|
+
await queryClient.prefetchQuery({
|
|
63
|
+
queryKey: ['boolean'],
|
|
64
|
+
queryFn: () => Promise.resolve(true),
|
|
65
|
+
})
|
|
66
|
+
await queryClient.prefetchQuery({
|
|
67
|
+
queryKey: ['null'],
|
|
68
|
+
queryFn: () => Promise.resolve(null),
|
|
69
|
+
})
|
|
70
|
+
await queryClient.prefetchQuery({
|
|
71
|
+
queryKey: ['array'],
|
|
72
|
+
queryFn: () => Promise.resolve(['string', 0]),
|
|
73
|
+
})
|
|
61
74
|
|
|
62
75
|
const persistClient = {
|
|
63
76
|
buster: 'test-buster',
|
|
@@ -83,16 +96,31 @@ describe('createpersister ', () => {
|
|
|
83
96
|
retry: removeOldestQuery,
|
|
84
97
|
})
|
|
85
98
|
|
|
86
|
-
await queryClient.prefetchQuery(
|
|
99
|
+
await queryClient.prefetchQuery({
|
|
100
|
+
queryKey: ['A'],
|
|
101
|
+
queryFn: () => Promise.resolve('A'.repeat(N)),
|
|
102
|
+
})
|
|
87
103
|
await sleep(1)
|
|
88
|
-
await queryClient.prefetchQuery(
|
|
104
|
+
await queryClient.prefetchQuery({
|
|
105
|
+
queryKey: ['B'],
|
|
106
|
+
queryFn: () => Promise.resolve('B'.repeat(N)),
|
|
107
|
+
})
|
|
89
108
|
await sleep(1)
|
|
90
|
-
await queryClient.prefetchQuery(
|
|
109
|
+
await queryClient.prefetchQuery({
|
|
110
|
+
queryKey: ['C'],
|
|
111
|
+
queryFn: () => Promise.resolve('C'.repeat(N)),
|
|
112
|
+
})
|
|
91
113
|
await sleep(1)
|
|
92
|
-
await queryClient.prefetchQuery(
|
|
114
|
+
await queryClient.prefetchQuery({
|
|
115
|
+
queryKey: ['D'],
|
|
116
|
+
queryFn: () => Promise.resolve('D'.repeat(N)),
|
|
117
|
+
})
|
|
93
118
|
|
|
94
119
|
await sleep(1)
|
|
95
|
-
await queryClient.prefetchQuery(
|
|
120
|
+
await queryClient.prefetchQuery({
|
|
121
|
+
queryKey: ['E'],
|
|
122
|
+
queryFn: () => Promise.resolve('E'.repeat(N)),
|
|
123
|
+
})
|
|
96
124
|
|
|
97
125
|
const persistClient = {
|
|
98
126
|
buster: 'test-limit',
|
|
@@ -111,7 +139,10 @@ describe('createpersister ', () => {
|
|
|
111
139
|
).not.toBeUndefined()
|
|
112
140
|
|
|
113
141
|
// update query Data
|
|
114
|
-
await queryClient.prefetchQuery(
|
|
142
|
+
await queryClient.prefetchQuery({
|
|
143
|
+
queryKey: ['A'],
|
|
144
|
+
queryFn: () => Promise.resolve('a'.repeat(N)),
|
|
145
|
+
})
|
|
115
146
|
const updatedPersistClient = {
|
|
116
147
|
buster: 'test-limit',
|
|
117
148
|
timestamp: Date.now(),
|
|
@@ -141,7 +172,10 @@ describe('createpersister ', () => {
|
|
|
141
172
|
retry: removeOldestQuery,
|
|
142
173
|
})
|
|
143
174
|
|
|
144
|
-
await queryClient.prefetchQuery(
|
|
175
|
+
await queryClient.prefetchQuery({
|
|
176
|
+
queryKey: ['A'],
|
|
177
|
+
queryFn: () => Promise.resolve('A'.repeat(N)),
|
|
178
|
+
})
|
|
145
179
|
await sleep(1)
|
|
146
180
|
|
|
147
181
|
const persistClient = {
|