Cache persister

@pinia/colada-plugin-cache-persister persists the query cache to storage and restores it on startup.

Install

bash

npm i @pinia/colada-plugin-cache-persister

Enable

import { PiniaColada } from '@pinia/colada'
import { PiniaColadaCachePersister } from '@pinia/colada-plugin-cache-persister'

app.use(PiniaColada, {
  plugins: [
    PiniaColadaCachePersister({
      // optional
      key: 'pinia-colada-cache',
      debounce: 1000,
      // storage: localStorage,
      // filter: { key: ['todos'] },
      // stringify: JSON.stringify,
      // parse: JSON.parse,
    }),
  ],
})

Async storage

If your storage is asynchronous (e.g. IndexedDB wrappers), you can wait for the cache to be ready before mounting:

import { isCacheReady } from '@pinia/colada-plugin-cache-persister'

await isCacheReady()
app.mount('#app')

Configuration

You can only configure the plugin globally, not per query:

key: string (default: 'pinia-colada-cache') is the key used in storage
storage: Storage (default: localStorage) is the storage to use (must implement getItem, setItem, and removeItem)
debounce: number (default: 1000) is the debounce delay in milliseconds before writing to storage
filter: { key: QueryKey[] } (default: undefined) is an optional filter to only persist certain queries (by key)
stringify: (cache) => string (default: JSON.stringify) converts the cache to a string before storing it
parse: (stored) => cache (default: JSON.parse) restores the cache from the stored string

Use stringify/parse with a codec like devalue to persist Date, Map, or custom classes. See Custom Serialization for examples.

Notes

Only successful query results are persisted.
Garbage collection still applies: if an entry is removed, it will disappear from persisted data too.
Serialization, deserialization, and storage failures are ignored because persisted data is treated as a best-effort cache.

Cache persister ​

Install ​

Enable ​

Async storage ​

Configuration ​

Notes ​

Links ​