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.

Installation

This utility comes packaged with react-query and is available under the react-query/createLocalStoragePersistor-experimental import.

Usage

• Import the createLocalStoragePersistor function
• Create a new localStoragePersistor
• Pass it to the persistQueryClient function

1 import { persistQueryClient } from 'react-query/persistQueryClient-experimental'
2 import { createLocalStoragePersistor } from 'react-query/createLocalStoragePersistor-experimental'
3 
4 const queryClient = new QueryClient({
5   defaultOptions: {
6     queries: {
7       cacheTime: 1000 * 60 * 60 * 24, // 24 hours
8     },
9   },
10 })
11 
12 const localStoragePersistor = createLocalStoragePersistor()
13 
14 persistQueryClient({
15   queryClient,
16   persistor: localStoragePersistor,
17 })

API

createLocalStoragePersistor

Call this function (with an optional options object) to create a localStoragePersistor that you can use later with persisteQueryClient.

 createLocalStoragePersistor(options?: CreateLocalStoragePersistorOptions)

Options

An optional object of options:

1 interface CreateLocalStoragePersistorOptions {
2   /** The key to use when storing the cache to localstorage */
3   localStorageKey?: string
4   /** To avoid localstorage spamming,
5    * pass a time in ms to throttle saving the cache to disk */
6   throttleTime?: number
7 }

The default options are:

1 {
2   localStorageKey = `REACT_QUERY_OFFLINE_CACHE`,
3   throttleTime = 1000,
4 }