push.rocks/taskbuffer

Fork 0

A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.

Go to file

Philipp Kunz b4a701d128 update npmextra.json: githost		2024-04-01 20:00:12 +02:00
.gitea/workflows	fix(core): update	2023-10-20 13:05:39 +02:00
.vscode	fix(core): update	2021-11-11 20:48:31 +01:00
test	feat(Task): Tasks can now be blocked by other tasks.	2023-08-04 13:03:28 +02:00
ts	fix(core): update	2023-10-20 13:05:39 +02:00
.gitignore	fix(core): update	2020-07-12 00:48:51 +00:00
.npmignore	update dependencies	2016-09-02 18:11:33 +02:00
LICENSE	Initial commit	2016-02-07 22:11:30 +01:00
npmextra.json	update npmextra.json: githost	2024-04-01 20:00:12 +02:00
package.json	3.1.7	2023-10-20 13:05:40 +02:00
pnpm-lock.yaml	fix(core): update	2023-10-20 13:05:39 +02:00
readme.md	fix(core): update	2023-07-26 14:16:33 +02:00
tsconfig.json	fix(core): update	2023-10-20 13:05:39 +02:00

readme.md

@push.rocks/taskbuffer

flexible task management. TypeScript ready!

Availabililty and Links

Status for master

Status Category	Status Badge
GitLab Pipelines
GitLab Pipline Test Coverage
npm
Snyk
TypeScript Support
node Support
Code Style
PackagePhobia (total standalone install weight)
PackagePhobia (package size on registry)
BundlePhobia (total size when bundled)

Usage

We highly recommend TypeScript as this module supports TypeScript intellisense.

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

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 or contribute monthly. :)

For further information read the linked docs at the top of this readme.

Legal

MIT licensed | © Task Venture Capital GmbH | By using this npm module you agree to our privacy policy