新增mixin函数简化loading相关操作生成

anthinkingcoder · anthinkingcoder · commit 109e1a4addcb · 2018-08-15T00:00:36.000+08:00
diff --git a/index.js b/index.js
@@ -1,3 +1,30 @@
+/**
+ * 自动为绑定loading的state属性生成loading的相关操作方法
+ * @param state
+ * @param getters
+ * @param mutations
+ * @param stateNameArray 要绑定loading的state属性数组
+ */
+function mixin({state, getters, mutations}, stateNameArray = []) {
+  stateNameArray.forEach(name => {
+    let loadingName;
+    if (typeof name === 'object') {
+      let stateName = Object.keys(name)[0]
+      if (Array.isArray(stateName) && !name[stateName]) {
+        throw new Error('When multiple state share a loading, the loading name not be null')
+      }
+      loadingName = name[stateName]
+    } else {
+      loadingName = normalizeLoadingName(name)
+    }
+    if (loadingName) {
+      state[loadingName] = false
+      getters[loadingName] = getLoadingGetter(loadingName)
+      mutations[normalizeMutationName(loadingName)] = getLoadingMutation(loadingName)
+    }
+  })
+}
+
 /**
  * 生成loading action
  * @param commit
@@ -41,36 +68,56 @@ function mapLoadingState(stateObj, totalLoadingName) {
 }
 
 /**
- * 生成loading mutation
+ * 生成loading mutation集合
  * @param nameArray mutation name数组
  * @returns {Array} 返回mutation方法数组
  */
-function mapLoadingMutation(nameArray = []) {
+function mapLoadingMutations(nameArray = []) {
   let res = {}
   nameArray.forEach(name => {
     let fnName = normalizeMutationName(name)
-    res[fnName] = (state, loading) => {
-      state[name] = loading
-    }
+    res[fnName] = getLoadingMutation(name)
   })
   return res
 }
 
+
 /**
- * 生成loading getters
+ * 生成loading getters集合
  * @param nameArray loading state name array
- * @returns {{}}
+ * @returns {{}} 返回getters方法数组
  */
-function mapLoadingGetter(nameArray = []) {
+function mapLoadingGetters(nameArray = []) {
   let res = {}
   normalizeMap(nameArray).forEach(item => {
-    res[item['key']] = (state) => {
-      return state[item['val']]
-    }
+    res[item['key']] = getLoadingGetter(item['val'])
   })
   return res
 }
 
+/**
+ * 生成一个loading mutation
+ * @param name state的属性名称
+ * @returns {function(*, *)}
+ */
+function getLoadingMutation(name) {
+  return (state, loading) => {
+    state[name] = loading
+  }
+}
+
+
+/**
+ * 生成一个loading getter
+ * @param val state的属性名称
+ * @returns {function(*, *)}
+ */
+function getLoadingGetter(val) {
+  return (state) => {
+    return state[val]
+  }
+}
+
 /**
  * 初始化变更函数名 loading -> setLoading
  * @param name
@@ -119,9 +166,15 @@ function pointer(commit, loading, fn) {
   }
 }
 
+
+export default {
+  mixin,
+  aopLoading
+}
 export {
+  mixin,
   aopLoading,
-  mapLoadingMutation,
+  mapLoadingMutations,
   mapLoadingState,
-  mapLoadingGetter
+  mapLoadingGetters
 }
diff --git a/lib/vuex-loading.js b/lib/vuex-loading.js
@@ -2,6 +2,44 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol" ? function (obj) {
+  return typeof obj;
+} : function (obj) {
+  return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj;
+};
+
+/**
+ * 自动为绑定loading的state属性生成loading的相关操作方法
+ * @param state
+ * @param getters
+ * @param mutations
+ * @param stateNameArray 要绑定loading的state属性数组
+ */
+function mixin(_ref) {
+  var state = _ref.state,
+      getters = _ref.getters,
+      mutations = _ref.mutations;
+  var stateNameArray = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+
+  stateNameArray.forEach(function (name) {
+    var loadingName = void 0;
+    if ((typeof name === 'undefined' ? 'undefined' : _typeof(name)) === 'object') {
+      var stateName = Object.keys(name)[0];
+      if (Array.isArray(stateName) && !name[stateName]) {
+        throw new Error('When multiple state share a loading, the loading name not be null');
+      }
+      loadingName = name[stateName];
+    } else {
+      loadingName = normalizeLoadingName(name);
+    }
+    if (loadingName) {
+      state[loadingName] = false;
+      getters[loadingName] = getLoadingGetter(loadingName);
+      mutations[normalizeMutationName(loadingName)] = getLoadingMutation(loadingName);
+    }
+  });
+}
+
 /**
  * 生成loading action
  * @param commit
@@ -58,40 +96,58 @@ function mapLoadingState(stateObj, totalLoadingName) {
 }
 
 /**
- * 生成loading mutation
+ * 生成loading mutation集合
  * @param nameArray mutation name数组
  * @returns {Array} 返回mutation方法数组
  */
-function mapLoadingMutation() {
+function mapLoadingMutations() {
   var nameArray = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
 
   var res = {};
   nameArray.forEach(function (name) {
     var fnName = normalizeMutationName(name);
-    res[fnName] = function (state, loading) {
-      state[name] = loading;
-    };
+    res[fnName] = getLoadingMutation(name);
   });
   return res;
 }
 
 /**
- * 生成loading getters
+ * 生成loading getters集合
  * @param nameArray loading state name array
- * @returns {{}}
+ * @returns {{}} 返回getters方法数组
  */
-function mapLoadingGetter() {
+function mapLoadingGetters() {
   var nameArray = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
 
   var res = {};
   normalizeMap(nameArray).forEach(function (item) {
-    res[item['key']] = function (state) {
-      return state[item['val']];
-    };
+    res[item['key']] = getLoadingGetter(item['val']);
   });
   return res;
 }
 
+/**
+ * 生成一个loading mutation
+ * @param name state的属性名称
+ * @returns {function(*, *)}
+ */
+function getLoadingMutation(name) {
+  return function (state, loading) {
+    state[name] = loading;
+  };
+}
+
+/**
+ * 生成一个loading getter
+ * @param val state的属性名称
+ * @returns {function(*, *)}
+ */
+function getLoadingGetter(val) {
+  return function (state) {
+    return state[val];
+  };
+}
+
 /**
  * 初始化变更函数名 loading -> setLoading
  * @param name
@@ -146,7 +202,14 @@ function pointer(commit, loading, fn) {
   };
 }
 
+var index = {
+  mixin: mixin,
+  aopLoading: aopLoading
+};
+
+exports.default = index;
+exports.mixin = mixin;
 exports.aopLoading = aopLoading;
-exports.mapLoadingMutation = mapLoadingMutation;
+exports.mapLoadingMutations = mapLoadingMutations;
 exports.mapLoadingState = mapLoadingState;
-exports.mapLoadingGetter = mapLoadingGetter;
+exports.mapLoadingGetters = mapLoadingGetters;
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "vuex-loading",
   "version": "1.0.0",
   "description": "",
-  "main": "index.js",
+  "main": "lib/vuex-loading.js",
   "scripts": {
     "build": "rollup -c rollup.config.js",
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -11,7 +11,10 @@
     "type": "git",
     "url": "git+https://github.com/anthinkingcoder/vuex-loading.git"
   },
-  "keywords": [],
+  "keywords": [
+    "vue",
+    "vuex"
+  ],
   "author": "anthinkingcoder jojo837769723@gmail.com",
   "license": "ISC",
   "bugs": {
