✨ Release v1

lib/index.js

@@ -9,7 +9,7 @@ const helpers_1 = require("./helpers");
 class PersistedState {
     constructor(opts, store) {
         const defaultOptions = {
-            key: 'vuex',
+            fileName: 'vuex',
             storageKey: 'state',
             paths: [],
             filter: undefined,
@@ -20,7 +20,7 @@ class PersistedState {
         };
         if (!opts.storage) {
             defaultOptions.storage = new electron_store_1.default({
-                name: defaultOptions.key
+                name: defaultOptions.fileName
             });
         }
         this.opts = Object.assign({}, defaultOptions, opts);
@@ -44,12 +44,12 @@ class PersistedState {
         }
     }
     loadInitialState() {
-        const state = this.getState();
-        if (!state)
+        const persistedState = this.getState();
+        if (!persistedState)
             return;
         if (this.opts.overwrite)
-            return this.store.replaceState(state);
-        const mergedState = deepmerge_1.default(this.store.state, state, {
+            return this.store.replaceState(persistedState);
+        const mergedState = deepmerge_1.default(this.store.state, persistedState, {
             arrayMerge: this.opts.arrayMerger
         });
         this.store.replaceState(mergedState);

lib/types.d.ts

@@ -1,7 +1,7 @@
 import Store from 'electron-store';
 import { MutationPayload } from 'vuex';
 export interface Options {
-    key?: string;
+    fileName?: string;
     storageKey?: string;
     paths?: string[];
     filter?: (mutation: MutationPayload) => boolean;
@@ -12,7 +12,7 @@ export interface Options {
     storage?: Store;
 }
 export interface FinalOptions {
-    key: string;
+    fileName: string;
     storageKey: string;
     paths: string[];
     filter?: (mutation: MutationPayload) => boolean;

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "vuex-electron-store",
-	"version": "0.1.0-beta",
-	"description": "",
+	"version": "0.1.0",
+	"description": "Persist and rehydrate your Vuex state in your Electron app.",
 	"main": "./lib/index.js",
 	"types": "./lib/index.d.ts",
 	"files": [
@@ -36,12 +36,12 @@
 	"devDependencies": {
 		"@betahuhn/config": "^1.1.0",
 		"@types/node": "^15.6.1",
-		"@typescript-eslint/eslint-plugin": "^4.24.0",
-		"@typescript-eslint/parser": "^4.24.0",
-		"eslint": "^7.26.0",
+		"@typescript-eslint/eslint-plugin": "^4.25.0",
+		"@typescript-eslint/parser": "^4.25.0",
+		"eslint": "^7.27.0",
 		"ts-node": "^9.1.1",
-		"tsc-watch": "^4.2.9",
-		"typescript": "^4.2.4",
+		"tsc-watch": "^4.4.0",
+		"typescript": "^4.3.2",
 		"vue": "^2.6.12",
 		"vuex": "^3.6.2"
 	},

src/index.ts

@@ -12,7 +12,7 @@ class PersistedState {
 
 	constructor(opts: Options, store: VuexStore<any>) {
 		const defaultOptions: any = {
-			key: 'vuex',
+			fileName: 'vuex',
 			storageKey: 'state',
 			paths: [],
 			filter: undefined,
@@ -24,7 +24,7 @@ class PersistedState {
 
 		if (!opts.storage) {
 			defaultOptions.storage = new Store({
-				name: defaultOptions.key
+				name: defaultOptions.fileName
 			})
 		}
 
@@ -53,12 +53,12 @@ class PersistedState {
 	}
 
 	loadInitialState(): void {
-		const state = this.getState()
-		if (!state) return
+		const persistedState = this.getState()
+		if (!persistedState) return
 
-		if (this.opts.overwrite) return this.store.replaceState(state)
+		if (this.opts.overwrite) return this.store.replaceState(persistedState)
 
-		const mergedState = merge(this.store.state, state, {
+		const mergedState = merge(this.store.state, persistedState, {
 			arrayMerge: this.opts.arrayMerger
 		})
 

src/types.ts

@@ -3,7 +3,7 @@ import Store from 'electron-store'
 import { MutationPayload } from 'vuex'
 
 export interface Options {
-	key?: string;
+	fileName?: string;
 	storageKey?: string;
 	paths?: string[];
 	filter?: (mutation: MutationPayload) => boolean;
@@ -15,7 +15,7 @@ export interface Options {
 }
 
 export interface FinalOptions {
-	key: string;
+	fileName: string;
 	storageKey: string;
 	paths: string[];
 	filter?: (mutation: MutationPayload) => boolean;