Merge pull request #18 from asmadsen/master

Improved testability; added possiblility to clear proxy cache

Author: michaelolof

README.md

@@ -11,6 +11,7 @@ A Type Safe Solution for Vuex Modules using ES6 Classes and ES7 Decorators that
   - `v.1.4.0` - async/await now works with actions in mutatate mode. 
   - `v.1.5.0` - JavaScript Support
   - `v.1.6.0` - NuxtJS Support.
+  - `v.1.7.0` - Improved testability.
 
 ## Installation
 ```
@@ -219,6 +220,23 @@ export class UserStore {
 }
 ```
 
+## How to test
+
+To test components where interact with the state using a proxy, you have to create the proxy for each test, and clear the proxy cache, to keep the state clean in between tests.
+
+If you are using jest, you could clear the proxy cache in the afterEach callback.
+```js
+describe('my test suite', () => {
+	...
+	afterEach(() => {
+		UserStore.ClearProxyCache(UserStore)
+	})
+	...
+})
+```
+
+To ensure your proxy is recreated for each test, the easiest way is to create the proxy inside the [component](#ok-so-what-about-vue-components). If not you could pass the proxy into the component using [provide/inject](https://vuejs.org/v2/api/#provide-inject), or mock the proxy if you are importing it from another file ie. like a [vuex manager](#vuex-manager).
+
 ## A note on Vuex Actions?
 Vuex Actions comes in two modes. A `mutate` mode and a `raw` mode. Both can be very useful.\
 For most of your use cases the `mutate` mode is all you'll need. The `raw` mode can be especially useful when you need access to `rootState` and `rootGetters`.\

dist/actions.js

@@ -1,10 +1,11 @@
 import { ActionRegister } from "./actions";
-import { _state, _mutations, _getters, _proxy, _map, _store, _namespacedPath, _actions_register, _actions, MutationFunction, GetterFunction, ActionFunction, VuexMap, _submodule, _module, _target } from "./symbols";
+import { _state, _mutations, _getters, _proxy, _map, _store, _namespacedPath, _actions_register, _actions, MutationFunction, GetterFunction, ActionFunction, VuexMap, _submodule, _module, _target } from './symbols';
 import { Store } from "vuex";
 export declare type VuexClassConstructor<T> = new () => T;
 export declare class VuexModule {
     static CreateSubModule<V extends typeof VuexModule>(SubModule: V): InstanceType<V>;
     static CreateProxy<V extends typeof VuexModule>($store: Store<any>, cls: V): InstanceType<V>;
+    static ClearProxyCache<V extends typeof VuexModule>(cls: V): void;
     static ExtractVuexModule(cls: typeof VuexModule): {
         namespaced: boolean;
         state: any;
@@ -16,7 +17,7 @@ export declare class VuexModule {
         modules: Record<string, any>;
     };
 }
-export declare function createProxy<V extends typeof VuexModule>($store: Store<any>, cls: V, cachePath: string): InstanceType<V>;
+export declare function createProxy<V extends typeof VuexModule>($store: Store<any>, cls: V, namespacedPath: string, cachePath: string): InstanceType<V>;
 export interface VuexModule {
     [_state]: Record<string, any>;
     [_mutations]: Record<string, MutationFunction>;