From 6e6d05661757ce89e98ffcad1dd3cb26cd9719b0 Mon Sep 17 00:00:00 2001 From: Phil Kunz Date: Mon, 10 Jul 2017 14:28:58 +0200 Subject: [PATCH] update docs --- docs/index.md | 3 +++ readme.md | 29 +++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 readme.md diff --git a/docs/index.md b/docs/index.md index 5fd7c8c..d0e4851 100644 --- a/docs/index.md +++ b/docs/index.md @@ -61,6 +61,9 @@ 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 diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..41b5b49 --- /dev/null +++ b/readme.md @@ -0,0 +1,29 @@ +# 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/) + +## Usage +Use TypeScript for best in class instellisense. + +For further information read the linked docs at the top of this README. + +> MIT licensed | **©** [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)