File size: 2,743 Bytes
1e92f2d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | import { asyncThrottle } from './asyncThrottle'
import { noop } from './utils'
import type {
AsyncStorage,
MaybePromise,
PersistedClient,
Persister,
Promisable,
} from '@tanstack/query-persist-client-core'
export type AsyncPersistRetryer = (props: {
persistedClient: PersistedClient
error: Error
errorCount: number
}) => Promisable<PersistedClient | undefined>
interface CreateAsyncStoragePersisterOptions {
/** The storage client used for setting and retrieving items from cache.
* For SSR pass in `undefined`. Note that window.localStorage can be
* `null` in Android WebViews depending on how they are configured.
*/
storage: AsyncStorage<string> | undefined | null
/** The key to use when storing the cache */
key?: string
/** To avoid spamming,
* pass a time in ms to throttle saving the cache to disk */
throttleTime?: number
/**
* How to serialize the data to storage.
* @default `JSON.stringify`
*/
serialize?: (client: PersistedClient) => MaybePromise<string>
/**
* How to deserialize the data from storage.
* @default `JSON.parse`
*/
deserialize?: (cachedString: string) => MaybePromise<PersistedClient>
retry?: AsyncPersistRetryer
}
export const createAsyncStoragePersister = ({
storage,
key = `REACT_QUERY_OFFLINE_CACHE`,
throttleTime = 1000,
serialize = JSON.stringify,
deserialize = JSON.parse,
retry,
}: CreateAsyncStoragePersisterOptions): Persister => {
if (storage) {
const trySave = async (
persistedClient: PersistedClient,
): Promise<Error | undefined> => {
try {
const serialized = await serialize(persistedClient)
await storage.setItem(key, serialized)
return
} catch (error) {
return error as Error
}
}
return {
persistClient: asyncThrottle(
async (persistedClient) => {
let client: PersistedClient | undefined = persistedClient
let error = await trySave(client)
let errorCount = 0
while (error && client) {
errorCount++
client = await retry?.({
persistedClient: client,
error,
errorCount,
})
if (client) {
error = await trySave(client)
}
}
},
{ interval: throttleTime },
),
restoreClient: async () => {
const cacheString = await storage.getItem(key)
if (!cacheString) {
return
}
return await deserialize(cacheString)
},
removeClient: () => storage.removeItem(key),
}
}
return {
persistClient: noop,
restoreClient: () => Promise.resolve(undefined),
removeClient: noop,
}
}
|