event-queue

Author: 2ue

.editorconfig

@@ -0,0 +1,14 @@
+# http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+insert_final_newline = false
+trim_trailing_whitespace = false

.eslintignore

@@ -0,0 +1,4 @@
+dist/
+node_modules
+iconfont.js
+common-module/

.eslintrc.json

@@ -0,0 +1,75 @@
+{
+  "parserOptions": {
+    "parser": "babel-eslint",
+    "ecmaVersion": 2017,
+    "ecmaFeatures": {
+      "implied": true
+    },
+    "sourceType": "module"
+  },
+  "env": {
+    "es6": true,
+    "node": true,
+    "browser": true
+  },
+  "extends": [
+    "airbnb-base",
+    "plugin:vue/essential"
+  ],
+  "rules": {
+    "prefer-destructuring": 0,
+    "destructuring": 0,
+    "no-useless-escape": 0,
+    "prefer-rest-params": 0,
+    "no-restricted-globals": 0,
+    "no-param-reassign": 0,
+    "no-console": 0,
+    "no-underscore-dangle": 0,
+    "class-methods-use-this": 0,
+    "no-tabs": 0,
+    "camelcase": 0,
+    "no-plusplus": 0,
+    "no-new": 0,
+    "no-use-before-define": 0,
+    "func-names": 0,
+    "prefer-const": 1,
+    "no-return-assign": 1,
+    "eqeqeq": 1,
+    "no-shadow": 1,
+    "no-restricted-syntax": 0,
+    "no-debugger": 0,
+    "import/no-dynamic-require": 0,
+    "one-var": 0,
+    "radix": 0,
+    "consistent-return": 1,
+    "no-unused-expressions": 1,
+    "no-unused-vars": 1,
+    "prefer-promise-reject-errors": 0,
+    "linebreak-style": 0,
+    "arrow-body-style": 0,
+    "global-require": 0,
+    "array-callback-return": 0,
+    "import/no-unresolved": 0,
+    "no-bitwise": [
+      2,
+      {
+        "allow": [
+          "~",
+          "&"
+        ]
+      }
+    ],
+    "import/no-extraneous-dependencies": [
+      0,
+      {
+        "devDependencies": true
+      }
+    ],
+    "no-mixed-operators": 0,
+    "guard-for-in": 0,
+    "no-multi-assign": 1,
+    "max-len": 0,
+    "vue/no-side-effects-in-computed-properties": 1,
+    "vue/require-v-for-key": 1
+  }
+}

.gitignore

@@ -1,61 +1,10 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
+/node_modules
+/npm-debug.log
+/app/logs
+node_modules/**
+.*/**
+dist
+package-lock.json
+*.lock
+*.bak.*
 
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# TypeScript v1 declaration files
-typings/
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-
-# next.js build output
-.next

README.md

@@ -1 +1,27 @@
-# event-queue
+# event-queue
+
+用来控制事件(异步或者同步)的管理
+
+## Use
+
+- maxEventNumber：{number} 允许最大并行任务数量，默认为5
+- async：{boolean} 是否需要异步执行，默认false
+- breakRun：{function} 用于中断继续向执行队列中添加任务，返回false(默认是false)表示继续添加
+
+```javascript
+  import EventQueue from './index';
+  const eventQueue = new EventQueue();
+  const eventList = [];
+  const eventArr = new Array(46).join(',').split(',');
+  eventArr.map(() => {
+    // 模拟事件发生
+    eventList.push(() => {
+      setTimeout(() => {
+        // do something...
+        // 调用完成标记, 通知执行下一个任务
+        eventQueue.done();
+      }, 6000 * Math.random());
+    });
+  });
+  eventQueue.add(taskList).run();
+```

index.js

@@ -0,0 +1,112 @@
+/**
+ * 事件队列
+ * 1.可以控制事件发生的最大并行数
+ * 2.打断队列中后续任务的添加，breakRun(eventOptions)来控制
+ * 3.允许在队列在执行过程中，继续向队列添加任务
+ * TO DO：
+ * 1.完成回调/执行结果返回，目前可以直接在外部处理结果
+ * 2.异常检查：对某些特殊错误进行检查
+ * 3.暂停/取消/销毁
+ * */
+
+const OPTIONS = {
+  // 任务同时执行的最大个数
+  maxEventNumber: 5,
+  // 队列任务是否并行(异步)执行。
+  // 注意：把maxEventNumber设置为1, async则不会起作用，此时本质上是同步
+  async: true,
+  // 用于中断继续向执行队列中添加任务，返回false(默认是false)表示继续添加
+  breakRun() {},
+  // TO DO 单个任务完成后执行，目前来说没必要，外部可以自由控制
+  complete() {},
+  // TO DO 所有任务完成后执行，目前来说没必要，外部可以自由控制
+  completeAll() {},
+};
+
+function fixedMaxEventNumber(number) {
+  return isNaN(number) || number <= 0 ? OPTIONS.maxEventNumber : number;
+}
+
+function EventQueue(options) {
+  this.init(options);
+}
+
+EventQueue.prototype = {
+  constructor: EventQueue,
+  /**
+   * 初始化实例配置
+   * */
+  init(options = {}) {
+    this.options = { ...OPTIONS, ...options };
+    // 修正maxEventNumber，防止报错
+    this.options.maxEventNumber = fixedMaxEventNumber(this.options.maxEventNumber);
+    // 事件队列合集
+    this.eventList = [];
+    // 正在执行的事件个数
+    this.eventRunNumber = 0;
+    // 已经完成的事件个数
+    this.eventOverNumber = 0;
+  },
+  /**
+   * 队列中单个任务结束标识
+   * 队列中函数结束时，需要手动调用此标识结束。
+   * 外部创建队列时使用
+   * */
+  done() {
+    // 计数
+    this.eventRunNumber -= 1;
+    this.eventOverNumber += 1;
+    this.run();
+  },
+  /**
+   * 把方法推送到队列中
+   * */
+  add(eventList) {
+    if (typeof eventList === 'function') eventList = [eventList];
+    if (eventList && eventList.length > 0) {
+      eventList.map((event) => {
+        this.on(event);
+      });
+    }
+    return this;
+  },
+  on(event) {
+    this.eventList.push(event);
+  },
+  /**
+   * 执行待执行队列(eventList)中的任务
+   * 执行队列中的任务不超过maxEventNumber值
+   * */
+  run() {
+    const {
+      eventList,
+      eventRunNumber,
+      eventOverNumber,
+      options,
+    } = this;
+    // 如果正在执行的队列超过限制，则中断
+    if (eventRunNumber >= options.maxEventNumber) return;
+    const eventIndex = eventRunNumber + eventOverNumber;
+    // 即将执行的任务
+    const event = eventList[eventIndex];
+    // 没有任务，执行完了
+    if (!event) return;
+    if (options.breakRun && options.breakRun({ eventRunNumber, eventOverNumber })) return;
+    // 执行当前任务
+    this.emit(event);
+    // 执行下一个任务
+    this.eventRunNumber += 1;
+    this.run();
+  },
+  emit(event) {
+    if (this.options.async) {
+      setTimeout(() => {
+        event.apply(this, arguments);
+      }, 6);
+    } else {
+      event.apply(this, arguments);
+    }
+  },
+};
+
+export default EventQueue;

package.json

@@ -0,0 +1,23 @@
+{
+  "name": "rsk-common-module",
+  "version": "1.0.0",
+  "description": "",
+  "scripts": {
+    "precommit-msg": "echo 'Pre-commit checks.........' && exit 0",
+    "lint": "eslint --ext .js --ext .vue ./ --fix && git add ."
+  },
+  "pre-commit": [
+    "precommit-msg",
+    "lint"
+  ],
+  "license": "ISC",
+  "dependencies": {},
+  "devDependencies": {
+    "babel-eslint": "^10.0.1",
+    "eslint": "^5.16.0",
+    "eslint-config-airbnb-base": "^13.1.0",
+    "eslint-plugin-import": "^2.16.0",
+    "eslint-plugin-vue": "^5.2.2",
+    "pre-commit": "^1.2.2"
+  }
+}