pinia-persist-plugin v1.0.3

pinia-persist-plugin

Opinionated persist plugin for pinia@next

Get Started

pnpm i pinia-persist-plugin

Usage

import { createApp } from 'vue'
import { createPinia } from 'pinia'
import { createPersistPlugin } from 'pinia-persist-plugin'

const pinia = createPinia()
const plugin = createPersistPlugin()
pinia.use(plugin)

const app = createApp(App)
app.use(pinia)

Configuration Options

interface Options {
  storage?: Storage // where to store the persistent
  storageKey?: string // which key to persist the store state
  omits?: string[] | string // store id[s] to omit persist
}

// The default config is here
const defaultOptions: Required<Options> = {
  storage: window.sessionStorage,
  storageKey: 'pinia-persist-plugin-state',
  omits: []
}

const plugin = createPersistPlugin(options?: Options)

Example

Can be accessed from playground folder