2.0.3

fix(ci): update testing framework to the new tstest
2.0.2
2018-08-05 23:10:01 +02:00 · 2018-08-05 23:10:00 +02:00 · 2018-08-04 18:03:23 +02:00 · 2018-08-04 18:03:22 +02:00 · 2018-08-04 18:02:41 +02:00 · 2018-08-04 18:02:41 +02:00
4 changed files with 98 additions and 108 deletions
--- a/docs/index.md
+++ b/docs/index.md
@ -1,87 +0,0 @@
-# taskbuffer
-
-flexible task management. TypeScript ready!
-
-## Availabililty
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/taskbuffer)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/taskbuffer)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/taskbuffer)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/taskbuffer/)
-
-## Status for master
-
-[![build status](https://GitLab.com/pushrocks/taskbuffer/badges/master/build.svg)](https://GitLab.com/pushrocks/taskbuffer/commits/master)
-[![coverage report](https://GitLab.com/pushrocks/taskbuffer/badges/master/coverage.svg)](https://GitLab.com/pushrocks/taskbuffer/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/taskbuffer.svg)](https://www.npmjs.com/package/taskbuffer)
-[![Dependency Status](https://david-dm.org/pushrocks/taskbuffer.svg)](https://david-dm.org/pushrocks/taskbuffer)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/taskbuffer/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/taskbuffer/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/taskbuffer/badges/code.svg)](https://www.bithound.io/github/pushrocks/taskbuffer)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
-
-## Install
-
-```sh
-npm install taskbuffer --save
-```
-
-## Concepts
-
-### class `Task`
-
- A Task in its most simple form is a function that is executed when the task runs.
- A Task can have a **preTask** and an **afterTask**
-  (those are run before or after the main function whenever the task is called)
- A Task can be buffered.
-  That means it can be called multiple times in a very short time.
-  However execution happens in line:
-  meaning execution of the task's main function is on halt until the previous task call has finished.
-  You can set bufferMax number, which is the max number of buffered task calls.
-  Any additional calls will then be truncated
- Task.trigger() and Task.triggerBuffered() always return a Promise
-  which is fullfilled once the related task call has completed.
- Task.triggered() is an Observable stream that emits events every time a task call is called and every time a call is completed.
- Task is compatible to gulp streams.
-
-### class `TaskChain`
-
- TaskChain extends Task.
- Multiple Tasks can be combined in a bigger task using a TaskChain.
- While the tasks are async in themselve, TaskChain **runs Tasks serialized** (one after the other)
- that means that tasks can rely on each other and
-
-### class `TaskParallel`
-
- TaskParallel extends Task.
- like TaskChain, however **tasks run in parallel**
- Tasks cannot rely on each other.
-
-### Usage
-
-We highly recommend TypeScript as this module supports **TypeScript intellisense**.
-
-```javascript
-import * as taskbuffer from "taskbuffer";
-
-myTask = new taskbuffer.Task({
-  preTask: someOtherTask // optional, don't worry loops are prevented
-  afterTask: someOtherTask // optional, don't worry loops are prevented
-  name:"myTask1",
-  buffered: true, // optional
-  bufferMax: 3, // optional, call qeues greater than this are truncated
-  execDelay: 1000, // optional, time in ms to wait before executing task call
-  taskFunction:() => {
-    // do some stuff and return promise
-    // pass on any data through promise resolution
-    // Use TypeScript for better understanding and code completion
-  }
-})
-```
-
-For further information read the linked docs at the top of this README.
-
-> MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
-
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
--- a/package-lock.json
+++ b/package-lock.json
@ -1,6 +1,6 @@
 {
-  "name": "taskbuffer",
-  "version": "2.0.0",
+  "name": "@pushrocks/taskbuffer",
+  "version": "2.0.3",
  "lockfileVersion": 1,
  "requires": true,
  "dependencies": {
@ -26,9 +26,9 @@
      }
    },
    "@gitzone/tstest": {
-      "version": "1.0.7",
-      "resolved": "https://registry.npmjs.org/@gitzone/tstest/-/tstest-1.0.7.tgz",
-      "integrity": "sha512-7F421u517blOgx9QtYfygSRA79aqDZqiSBAoR9YQGVTgehEnmMva7JQM50SuQxhDQ9TUEX0fPARPrZWFreZ2wg==",
+      "version": "1.0.11",
+      "resolved": "https://registry.npmjs.org/@gitzone/tstest/-/tstest-1.0.11.tgz",
+      "integrity": "sha512-f07enMUm/jMVyHBK8w98DBoFhf2xo+DJKDlawDrWUTIv3mm2hQ05gmMNjmk82j9HamLcz0/sTldULHVSBaxIXw==",
      "dev": true,
      "requires": {
        "@gitzone/tsrun": "^1.1.9",
@ -36,7 +36,9 @@
        "@pushrocks/smartfile": "^6.0.3",
        "@pushrocks/smartlog": "^2.0.1",
        "@pushrocks/smartpromise": "^2.0.5",
-        "@pushrocks/smartshell": "^2.0.5"
+        "@pushrocks/smartshell": "^2.0.5",
+        "@types/figures": "^2.0.0",
+        "figures": "^2.0.0"
      }
    },
    "@pushrocks/consolecolor": {
@ -168,6 +170,12 @@
      "resolved": "https://registry.npmjs.org/@types/cron/-/cron-1.3.0.tgz",
      "integrity": "sha512-RNJ6Hbxs9CbUw+Bxt8kpN8/yNlYG1xli0JZSO1xTJJxFjgD2KWctFSkJeJpjf9iLJU0jeNPoJ5LEru7eBN3xuA=="
    },
+    "@types/figures": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/@types/figures/-/figures-2.0.0.tgz",
+      "integrity": "sha512-mcRgJ+ncKuNI+Dwac7omO18B8C8u+YBS+AU/oyLhEyjAnT3cUUThhHgZpbiIvu5ZqSvdD30BXtrqg9nxc3OKMg==",
+      "dev": true
+    },
    "@types/form-data": {
      "version": "2.2.1",
      "resolved": "https://registry.npmjs.org/@types/form-data/-/form-data-2.2.1.tgz",
@ -187,9 +195,9 @@
      }
    },
    "@types/lodash": {
-      "version": "4.14.115",
-      "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.14.115.tgz",
-      "integrity": "sha512-9K/P4XMQxk61omAzQh3bbbFiqnG17eLcFysjlAYz0aPcYrVo8T+ujaCeIeY0Gpzux7x1YbxtEtLKB7ZWf79qdg=="
+      "version": "4.14.116",
+      "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.14.116.tgz",
+      "integrity": "sha512-lRnAtKnxMXcYYXqOiotTmJd74uawNWuPnsnPrrO7HiFuE3npE2iQhfABatbYDyxTNqZNuXzcKGhw37R7RjBFLg=="
    },
    "@types/minimatch": {
      "version": "3.0.3",
@ -197,9 +205,9 @@
      "integrity": "sha512-tHq6qdbT9U1IRSGf14CL0pUlULksvY9OZ+5eEgl1N7t+OA3tGvNpxJCzuKQlsNgCVwbAs670L1vcVQi8j9HjnA=="
    },
    "@types/node": {
-      "version": "10.5.4",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-10.5.4.tgz",
-      "integrity": "sha512-8TqvB0ReZWwtcd3LXq3YSrBoLyXFgBX/sBZfGye9+YS8zH7/g+i6QRIuiDmwBoTzcQ/pk89nZYTYU4c5akKkzw==",
+      "version": "10.5.6",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-10.5.6.tgz",
+      "integrity": "sha512-c5Z1j1ysgo4878ptz6gxLcgMfJ6Wf908R3l5KAGabr0XJ72ZFmOCgsaodPpNYTfp4iOrSwgTDvR/BxbFfB4zPQ==",
      "dev": true
    },
    "@types/vinyl": {
@ -450,12 +458,27 @@
      "integrity": "sha512-Um/+FxMr9CISWh0bi5Zv0iOD+4cFh5qLeks1qhAopKVAJw3drgKbKySikp7wGhDL0HPeaja0P5ULZrxLkniUVg==",
      "dev": true
    },
+    "escape-string-regexp": {
+      "version": "1.0.5",
+      "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz",
+      "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=",
+      "dev": true
+    },
    "esprima": {
      "version": "4.0.1",
      "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz",
      "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==",
      "dev": true
    },
+    "figures": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/figures/-/figures-2.0.0.tgz",
+      "integrity": "sha1-OrGi0qYsi/tDGgyUy3l6L84nyWI=",
+      "dev": true,
+      "requires": {
+        "escape-string-regexp": "^1.0.5"
+      }
+    },
    "first-chunk-stream": {
      "version": "2.0.0",
      "resolved": "https://registry.npmjs.org/first-chunk-stream/-/first-chunk-stream-2.0.0.tgz",
--- a/package.json
+++ b/package.json
@ -1,6 +1,7 @@
 {
  "name": "@pushrocks/taskbuffer",
-  "version": "2.0.0",
+  "version": "2.0.3",
+  "private": false,
  "description": "flexible task management. TypeScript ready!",
  "main": "dist/index.js",
  "typings": "dist/index.d.ts",
@ -35,9 +36,8 @@
    "rxjs": "^6.2.2"
  },
  "devDependencies": {
-    "@gitzone/tstest": "^1.0.7",
+    "@gitzone/tstest": "^1.0.11",
    "@pushrocks/tapbundle": "^3.0.1",
-    "@types/node": "^10.5.4"
-  },
-  "private": true
+    "@types/node": "^10.5.6"
+  }
 }
--- a/readme.md
+++ b/readme.md
@ -1,4 +1,4 @@
-# @pushrocks/taskbuffer
+# taskbuffer

 flexible task management. TypeScript ready!

@ -21,13 +21,67 @@ flexible task management. TypeScript ready!
 [![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
 [![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)

-## Usage
+## Install

-Use TypeScript for best in class instellisense.
+```sh
+npm install taskbuffer --save
+```
+
+## Concepts
+
+### class `Task`
+
+- A Task in its most simple form is a function that is executed when the task runs.
+- A Task can have a **preTask** and an **afterTask**
+  (those are run before or after the main function whenever the task is called)
+- A Task can be buffered.
+  That means it can be called multiple times in a very short time.
+  However execution happens in line:
+  meaning execution of the task's main function is on halt until the previous task call has finished.
+  You can set bufferMax number, which is the max number of buffered task calls.
+  Any additional calls will then be truncated
+- Task.trigger() and Task.triggerBuffered() always return a Promise
+  which is fullfilled once the related task call has completed.
+- Task.triggered() is an Observable stream that emits events every time a task call is called and every time a call is completed.
+- Task is compatible to gulp streams.
+
+### class `TaskChain`
+
+- TaskChain extends Task.
+- Multiple Tasks can be combined in a bigger task using a TaskChain.
+- While the tasks are async in themselve, TaskChain **runs Tasks serialized** (one after the other)
+- that means that tasks can rely on each other and
+
+### class `TaskParallel`
+
+- TaskParallel extends Task.
+- like TaskChain, however **tasks run in parallel**
+- Tasks cannot rely on each other.
+
+### Usage
+
+We highly recommend TypeScript as this module supports **TypeScript intellisense**.
+
+```javascript
+import * as taskbuffer from "taskbuffer";
+
+myTask = new taskbuffer.Task({
+  preTask: someOtherTask // optional, don't worry loops are prevented
+  afterTask: someOtherTask // optional, don't worry loops are prevented
+  name:"myTask1",
+  buffered: true, // optional
+  bufferMax: 3, // optional, call qeues greater than this are truncated
+  execDelay: 1000, // optional, time in ms to wait before executing task call
+  taskFunction:() => {
+    // do some stuff and return promise
+    // pass on any data through promise resolution
+    // Use TypeScript for better understanding and code completion
+  }
+})
+```

 For further information read the linked docs at the top of this README.

 > MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
-> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)

 [![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
Author	SHA1	Message	Date
Phil Kunz	f74da6ff0b	2.0.3	2018-08-05 23:10:01 +02:00
Phil Kunz	e9d976ad1e	fix(ci): update testing framework to the new tstest	2018-08-05 23:10:00 +02:00
Phil Kunz	f6d314695a	2.0.2	2018-08-04 18:03:23 +02:00
Phil Kunz	d35b34f4aa	fix(package.json): update private param	2018-08-04 18:03:22 +02:00
Phil Kunz	9fec5ce62e	2.0.1	2018-08-04 18:02:41 +02:00
Phil Kunz	7577479368	fix(docs): update docs	2018-08-04 18:02:41 +02:00