pinia-persists

Pinia Persists

A pinia plugin for state persist.

English | 简体中文

Usage

Install

npm i pinia-persists

Use

import { persist } from 'pinia-persists'
import { createPinia } from 'pinia'

const pinia = createPinia()

// pinia use plugin
pinia.use(persist({ /* options */ }))

app.use(pinia)

Options

prefix

• type: String
• optional, default "pinia"
• it is the prefix of the key to store the persisted state under, such as the store id is "test", that store key is "pinia_test" by default.

storage

• type: Object

  interface Storage {
      readonly length?: number;
      clear?: () => void;
      getItem: (key: string) => string | null;
      key?: (index: number) => string | null;
      removeItem?: (key: string) => void;
      setItem: (key: string, value: string) => void;
      [name: string]: any;
  }
  

• optional, default window.localStorage

• it is the storage for state persist, you can choose localStorage, sessionStorage or your custom storage.

overwrite

• type: Boolean
• optional, default false
• when app first loader or refresh, whether to overwrite the existing state with the output from state directly, instead of merging the two objects with deep merge.

License

MIT License © 2022 Dewey Ou