vuex-persistedstate

vuex-persistedstate

Persist Vuex state with localStorage.

Installation

$ npm install vuex-persistedstate

Usage

import createPersistedState from 'vuex-persistedstate'

const store = new Vuex.Store({
  // ...
  plugins: [createPersistedState()]
})

API

createPersistedState([options])

Creates a new instance of the plugin with the given options. The following options can be provided to configure the plugin for your specific needs:

• key <String>: The key to store the persisted state under. (default: vuex)
• paths <Array>: An array of any paths to partially persist the state. If no paths are given, the complete state is persisted. (default: [])
• getState <Function>: A function that will be called to rehydrate a previously persisted state. Defaults to localStorage.
• setState <Function>: A function that will be called to persist the given state. Defaults to localStorage.

License

MIT