VERY IMPORTANT: This plugin 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 plugin comes packaged with
react-query and is available under the
persistWithLocalStorage function, and pass it your
QueryClient instance (with a
IMPORTANT - for persist to work properly, you need to pass
cacheTime value to override the default during hydration (as shown above).
If it is not set when creating the
QueryClient instance, it will default to
300000 (5 minutes) for hydration, and local storage will be discarded after 5 minutes of inactivity. This is the default garbage collection behavior.
It should be set as the same value or higher than persistWithLocalStorage's
maxAge option. E.g. if
maxAge is 24 hours (the default) then
cacheTime should be 24 hours or higher. If lower than
maxAge, garbage collection will kick in and discard the local storage earlier than expected.
You can also pass it
Infinity to disable garbage collection behavior entirely.
As you use your application:
When you reload/bootstrap your app:
maxAge(which by default is 24 hours), it will be discarded. This can be customized as you see fit.
Sometimes you may make changes to your application or data that immediately invalidate any and all cached data. If and when this happens, you can pass a
buster string option to
persistWithLocalStorage, and if the cache that is found does not also have that buster string, it will be discarded.
Pass this function a
QueryClient instance to persist it to localstorage.
An optional object of options:
The default options are: