id | title |
---|---|
createLocalStoragePersistor |
createLocalStoragePersistor (Experimental) |
VERY IMPORTANT: This utility is currently in an experimental stage. This means that breaking changes will happen in minor AND patch releases. Use at your own risk. If you choose to rely on this in production in an experimental stage, please lock your version to a patch-level version to avoid unexpected breakages.
This utility comes packaged with svelte-query
and is available under the @sveltestack/svelte-query
import.
- Import the
createLocalStoragePersistor
function - Create a new localStoragePersistor
- Pass it to the
persistQueryClient
function
import { persistQueryClient } from from '@sveltestack/svelte-query'
import { createLocalStoragePersistor } from from '@sveltestack/svelte-query'
const queryClient = new QueryClient({
defaultOptions: {
queries: {
cacheTime: 1000 * 60 * 60 * 24, // 24 hours
},
},
})
const localStoragePersistor = createLocalStoragePersistor()
persistQueryClient({
queryClient
persistor: localStoragePersistor,
})
Call this function (with an optional options object) to create a localStoragePersistor that you can use later with persisteQueryClient
.
createLocalStoragePersistor(options?: CreateLocalStoragePersistorOptions)
An optional object of options:
interface CreateLocalStoragePersistorOptions {
/** The key to use when storing the cache to localstorage */
localStorageKey?: string
/** To avoid localstorage spamming,
* pass a time in ms to throttle saving the cache to disk */
throttleTime?: number
}
The default options are:
{
localStorageKey = `SVELTE_QUERY_OFFLINE_CACHE`,
throttleTime = 1000,
}