push.rocks/taskbuffer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update Readme

Browse Source
This commit is contained in:
LosslessBot 2016-05-04 04:11:22 +02:00
parent f815773ba3
commit e29f5d1633
2 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -9,3 +9,11 @@ Flexible task organization for gulp.
```sh ```sh
npm install taskbuffer --save npm install taskbuffer --save
``` ```
## Concepts
#### Task
* A Task in its most simple form is a function that is executed when the task runs.
* It can have a preTaska 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.
* Multiple Tasks can be combined in a bigger task using a Taskchain. Taskchain extends Task.

2
ts/taskbuffer.classes.task.ts
View File

@ -3,7 +3,7 @@ import * as plugins from "./taskbuffer.plugins"
import * as helpers from "./taskbuffer.classes.helpers" import * as helpers from "./taskbuffer.classes.helpers"
export class Task { export class Task {
task:any; task:function;
idle:boolean; idle:boolean;
running:boolean; running:boolean;
buffered:boolean; buffered:boolean;