update docs

2017-07-10 14:28:58 +02:00
parent 3f7f38ee17
commit 6e6d056617
2 changed files with 32 additions and 0 deletions
--- 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