62 lines
3.3 KiB
Markdown
62 lines
3.3 KiB
Markdown
# @push.rocks/taskbuffer
|
|
flexible task management. TypeScript ready!
|
|
|
|
## Availabililty and Links
|
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/taskbuffer)
|
|
* [gitlab.com (source)](https://gitlab.com/push.rocks/taskbuffer)
|
|
* [github.com (source mirror)](https://github.com/push.rocks/taskbuffer)
|
|
* [docs (typedoc)](https://push.rocks.gitlab.io/taskbuffer/)
|
|
|
|
## Status for master
|
|
|
|
Status Category | Status Badge
|
|
-- | --
|
|
GitLab Pipelines | [](https://lossless.cloud)
|
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
|
npm | [](https://lossless.cloud)
|
|
Snyk | [](https://lossless.cloud)
|
|
TypeScript Support | [](https://lossless.cloud)
|
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
Code Style | [](https://lossless.cloud)
|
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
|
|
|
## 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 | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
|
|
[](https://push.rocks)
|
|
|
|
## Contribution
|
|
|
|
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
|
|
|
For further information read the linked docs at the top of this readme.
|
|
|
|
## Legal
|
|
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|