README.md

Vuex State and Storage(local, session) Synchronization module

🕹Guide

Install

$ npm install --save vuex-state-storage-sync

Usage

import Vue from 'vue';
import Vuex from 'vuex';
import syncStateStorage from 'vuex-state-storage-sync';

Vue.use(Vuex);

export default new Vuex.Store({
  state: {
    // ...
  },
  getters: {
    // ...
  },
  mutations: {
    // ...
  },
  actions: {
    // ...
  },
  modules: {
    // ...
  }
  plugins: [
    syncStateStorage({
      storage: window.localStorage || window.sessionStorage, // Storage Types
      key: '',  // Storage Key Name
      path: [''] // State data to be synchronized to storage
    })
  ]
});

📬 Recommended Commit Message

When	Commit Message
Add function	feat: ⚡️ Add function
Fix bug	fix: 🐞 Fix bug
Refactoring	refactor: 🛠 Refactoring
Add package	package: 📦 Add package
Fix readme	docs: 📚 Fix readme
Improvements style	style: 👁 Improvements style

💳 License

MIT