Update Readme
This commit is contained in:
parent
f815773ba3
commit
e29f5d1633
10
README.md
10
README.md
@ -8,4 +8,12 @@ Flexible task organization for gulp.
|
||||
|
||||
```sh
|
||||
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.
|
@ -3,7 +3,7 @@ import * as plugins from "./taskbuffer.plugins"
|
||||
import * as helpers from "./taskbuffer.classes.helpers"
|
||||
|
||||
export class Task {
|
||||
task:any;
|
||||
task:function;
|
||||
idle:boolean;
|
||||
running:boolean;
|
||||
buffered:boolean;
|
||||
|
Loading…
Reference in New Issue
Block a user