Compare commits
13 Commits
Author | SHA1 | Date | |
---|---|---|---|
863adb3b8c | |||
67f01417b6 | |||
65886287c6 | |||
fdaf772cfc | |||
757b992440 | |||
b4a701d128 | |||
ca3ef8ced6 | |||
6115bae66b | |||
1be83af475 | |||
bd14c41edc | |||
d61b79282d | |||
1cba9245fe | |||
4b0db4da21 |
@@ -119,6 +119,6 @@ jobs:
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
pnpm install -g @gitzone/tsdoc
|
||||
pnpm install -g @git.zone/tsdoc
|
||||
npmci command tsdoc
|
||||
continue-on-error: true
|
||||
|
BIN
.serena/cache/typescript/document_symbols_cache_v23-06-25.pkl
vendored
Normal file
BIN
.serena/cache/typescript/document_symbols_cache_v23-06-25.pkl
vendored
Normal file
Binary file not shown.
35
.serena/memories/code_style_conventions.md
Normal file
35
.serena/memories/code_style_conventions.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# Code Style and Conventions for TaskBuffer
|
||||
|
||||
## File Structure
|
||||
- Source code in `ts/` directory
|
||||
- Tests in `test/` directory
|
||||
- Compiled output in `dist_ts/`
|
||||
- All filenames must be lowercase
|
||||
|
||||
## Naming Conventions
|
||||
- **Interfaces**: Prefix with `I` (e.g., `ITaskFunction`)
|
||||
- **Types**: Prefix with `T` (e.g., `TPreOrAfterTaskFunction`)
|
||||
- **Classes**: PascalCase (e.g., `TaskManager`)
|
||||
- **Files**: `taskbuffer.classes.{classname}.ts` pattern
|
||||
- **Test files**: `test.{number}.{feature}.ts` pattern
|
||||
|
||||
## TypeScript Conventions
|
||||
- Use ES modules (import/export)
|
||||
- Avoid ENums when possible
|
||||
- Import dependencies through `plugins.ts`
|
||||
- Reference with full path: `plugins.myModule.myClass()`
|
||||
- Use async/await patterns consistently
|
||||
- Strong typing throughout
|
||||
|
||||
## Testing Conventions
|
||||
- Import expect from `@git.zone/tstest/tapbundle`
|
||||
- Test files end with `export default tap.start()`
|
||||
- Use descriptive test names with tap.test()
|
||||
- Test both browser and node when applicable
|
||||
|
||||
## Code Quality
|
||||
- Make focused, goal-oriented changes
|
||||
- Preserve necessary complexity
|
||||
- Keep code elegant and maintainable
|
||||
- No inline documentation unless requested
|
||||
- Complete implementations only (no partial work)
|
27
.serena/memories/project_overview.md
Normal file
27
.serena/memories/project_overview.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# TaskBuffer Project Overview
|
||||
|
||||
## Purpose
|
||||
@push.rocks/taskbuffer is a powerful TypeScript-first task management library for orchestrating asynchronous operations. It provides flexible task execution patterns including buffered execution, task chains, parallel execution, scheduling, debouncing, and one-time execution.
|
||||
|
||||
## Tech Stack
|
||||
- **Language**: TypeScript (ES modules)
|
||||
- **Runtime**: Node.js
|
||||
- **Build Tool**: tsbuild, tsbundle
|
||||
- **Test Framework**: @git.zone/tstest (tapbundle)
|
||||
- **Package Manager**: pnpm
|
||||
- **Module System**: ES modules (type: "module")
|
||||
|
||||
## Key Features
|
||||
- Task: Basic unit of work with async function wrapping
|
||||
- Taskchain: Sequential task execution with result passing
|
||||
- Taskparallel: Parallel task execution
|
||||
- TaskManager: Cron-based task scheduling
|
||||
- TaskDebounced: Debounced execution pattern
|
||||
- TaskOnce: Singleton execution pattern
|
||||
- TaskRunner: Distributed task execution
|
||||
- BufferRunner: Smart concurrent execution control
|
||||
|
||||
## Main Entry Points
|
||||
- Main export: `ts/index.ts`
|
||||
- Compiled output: `dist_ts/index.js`
|
||||
- All classes exported from index for clean API
|
67
.serena/memories/suggested_commands.md
Normal file
67
.serena/memories/suggested_commands.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# Suggested Commands for TaskBuffer Development
|
||||
|
||||
## Build and Test Commands
|
||||
```bash
|
||||
# Build the project
|
||||
pnpm run build
|
||||
|
||||
# Run tests
|
||||
pnpm test
|
||||
|
||||
# Type checking
|
||||
tsbuild check test/**/* --skiplibcheck
|
||||
|
||||
# Build documentation
|
||||
pnpm run buildDocs
|
||||
```
|
||||
|
||||
## Development Workflow
|
||||
```bash
|
||||
# Install dependencies
|
||||
pnpm install
|
||||
|
||||
# Add development dependency
|
||||
pnpm install --save-dev <package>
|
||||
|
||||
# Add production dependency
|
||||
pnpm add <package>
|
||||
|
||||
# Run specific test
|
||||
tstest test/test.some.ts --verbose
|
||||
|
||||
# Run tests with logging
|
||||
tstest test/test.some.ts --logfile
|
||||
```
|
||||
|
||||
## Git Commands
|
||||
```bash
|
||||
# View status
|
||||
git status
|
||||
|
||||
# Stage changes
|
||||
git add .
|
||||
|
||||
# Commit with message
|
||||
git commit -m "message"
|
||||
|
||||
# Use git mv for file operations to preserve history
|
||||
git mv oldfile newfile
|
||||
```
|
||||
|
||||
## System Commands (Linux)
|
||||
```bash
|
||||
# List files
|
||||
ls -la
|
||||
|
||||
# Find files
|
||||
find . -name "*.ts"
|
||||
|
||||
# Search in files
|
||||
rg "pattern" # Use ripgrep instead of grep
|
||||
|
||||
# View file
|
||||
cat filename
|
||||
|
||||
# Create directory
|
||||
mkdir -p path/to/dir
|
||||
```
|
37
.serena/memories/task_completion_checklist.md
Normal file
37
.serena/memories/task_completion_checklist.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# Task Completion Checklist for TaskBuffer
|
||||
|
||||
## Before Marking Any Task Complete
|
||||
|
||||
### 1. Code Quality Checks
|
||||
- [ ] Run build to ensure TypeScript compiles: `pnpm run build`
|
||||
- [ ] Run tests to ensure nothing breaks: `pnpm test`
|
||||
- [ ] Type check test files: `tsbuild check test/**/* --skiplibcheck`
|
||||
|
||||
### 2. Code Review
|
||||
- [ ] All changes are focused and purposeful
|
||||
- [ ] No unnecessary modifications made
|
||||
- [ ] Code follows project naming conventions
|
||||
- [ ] Imports use the plugins.ts pattern where applicable
|
||||
- [ ] All async operations use proper async/await
|
||||
|
||||
### 3. Testing
|
||||
- [ ] New features have corresponding tests
|
||||
- [ ] Existing tests still pass
|
||||
- [ ] Test files end with `export default tap.start()`
|
||||
- [ ] Tests use proper expect from tapbundle
|
||||
|
||||
### 4. Documentation
|
||||
- [ ] readme.md updated if new features added
|
||||
- [ ] Code is self-explanatory (no comments unless requested)
|
||||
- [ ] API changes documented
|
||||
|
||||
### 5. Git Hygiene
|
||||
- [ ] Changes are staged appropriately
|
||||
- [ ] Commit message is clear and focused
|
||||
- [ ] NO commits made without explicit user approval
|
||||
|
||||
## Common Issues to Check
|
||||
- No uppercase filenames
|
||||
- No direct npm usage (use pnpm)
|
||||
- No guessing APIs (always check documentation)
|
||||
- No partial implementations
|
68
.serena/project.yml
Normal file
68
.serena/project.yml
Normal file
@@ -0,0 +1,68 @@
|
||||
# language of the project (csharp, python, rust, java, typescript, go, cpp, or ruby)
|
||||
# * For C, use cpp
|
||||
# * For JavaScript, use typescript
|
||||
# Special requirements:
|
||||
# * csharp: Requires the presence of a .sln file in the project folder.
|
||||
language: typescript
|
||||
|
||||
# whether to use the project's gitignore file to ignore files
|
||||
# Added on 2025-04-07
|
||||
ignore_all_files_in_gitignore: true
|
||||
# list of additional paths to ignore
|
||||
# same syntax as gitignore, so you can use * and **
|
||||
# Was previously called `ignored_dirs`, please update your config if you are using that.
|
||||
# Added (renamed) on 2025-04-07
|
||||
ignored_paths: []
|
||||
|
||||
# whether the project is in read-only mode
|
||||
# If set to true, all editing tools will be disabled and attempts to use them will result in an error
|
||||
# Added on 2025-04-18
|
||||
read_only: false
|
||||
|
||||
|
||||
# list of tool names to exclude. We recommend not excluding any tools, see the readme for more details.
|
||||
# Below is the complete list of tools for convenience.
|
||||
# To make sure you have the latest list of tools, and to view their descriptions,
|
||||
# execute `uv run scripts/print_tool_overview.py`.
|
||||
#
|
||||
# * `activate_project`: Activates a project by name.
|
||||
# * `check_onboarding_performed`: Checks whether project onboarding was already performed.
|
||||
# * `create_text_file`: Creates/overwrites a file in the project directory.
|
||||
# * `delete_lines`: Deletes a range of lines within a file.
|
||||
# * `delete_memory`: Deletes a memory from Serena's project-specific memory store.
|
||||
# * `execute_shell_command`: Executes a shell command.
|
||||
# * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced.
|
||||
# * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
|
||||
# * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
|
||||
# * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
|
||||
# * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file.
|
||||
# * `initial_instructions`: Gets the initial instructions for the current project.
|
||||
# Should only be used in settings where the system prompt cannot be set,
|
||||
# e.g. in clients you have no control over, like Claude Desktop.
|
||||
# * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
|
||||
# * `insert_at_line`: Inserts content at a given line in a file.
|
||||
# * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
|
||||
# * `list_dir`: Lists files and directories in the given directory (optionally with recursion).
|
||||
# * `list_memories`: Lists memories in Serena's project-specific memory store.
|
||||
# * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building).
|
||||
# * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context).
|
||||
# * `read_file`: Reads a file within the project directory.
|
||||
# * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store.
|
||||
# * `remove_project`: Removes a project from the Serena configuration.
|
||||
# * `replace_lines`: Replaces a range of lines within a file with new content.
|
||||
# * `replace_symbol_body`: Replaces the full definition of a symbol.
|
||||
# * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen.
|
||||
# * `search_for_pattern`: Performs a search for a pattern in the project.
|
||||
# * `summarize_changes`: Provides instructions for summarizing the changes made to the codebase.
|
||||
# * `switch_modes`: Activates modes by providing a list of their names
|
||||
# * `think_about_collected_information`: Thinking tool for pondering the completeness of collected information.
|
||||
# * `think_about_task_adherence`: Thinking tool for determining whether the agent is still on track with the current task.
|
||||
# * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed.
|
||||
# * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store.
|
||||
excluded_tools: []
|
||||
|
||||
# initial prompt for the project. It will always be given to the LLM upon activating the project
|
||||
# (contrary to the memories, which are loaded on demand).
|
||||
initial_prompt: ""
|
||||
|
||||
project_name: "taskbuffer"
|
84
changelog.md
Normal file
84
changelog.md
Normal file
@@ -0,0 +1,84 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-08-26 - 3.1.8 - fix(tests)
|
||||
Update test runner and imports, refresh README and package metadata, add project tooling/config files
|
||||
|
||||
- Replaced test imports from '@push.rocks/tapbundle' to '@git.zone/tstest/tapbundle' across test files
|
||||
- Updated test script in package.json to run tstest with --verbose --logfile --timeout 120
|
||||
- Bumped devDependency @git.zone/tstest to ^2.3.5 and adjusted package.json fields (typings, packageManager)
|
||||
- Expanded and rewrote README with detailed examples, API reference, and usage guidance
|
||||
- Refactored TaskManager tests (removed duplicate both-file and added consolidated test/test.4.taskmanager.ts)
|
||||
- Added development/project tooling and metadata files (.claude settings, .serena project/memories) to aid local development and CI
|
||||
|
||||
## 2024-05-29 - 3.1.7 - maintenance/config
|
||||
Updated package metadata and build configuration.
|
||||
|
||||
- Updated package description.
|
||||
- Multiple TypeScript configuration updates (tsconfig).
|
||||
- Updated npmextra.json githost entries (changes across 2024-03-30, 2024-04-01, 2024-04-14).
|
||||
|
||||
## 2023-08-04 - 3.0.15 - feat(Task)
|
||||
Tasks can now be blocked by other tasks.
|
||||
|
||||
- Introduced task blocking support in the Task implementation.
|
||||
- Release contains related maintenance and patch fixes.
|
||||
|
||||
## 2023-01-07 to 2023-10-20 - 3.0.4..3.1.6 - maintenance
|
||||
Series of patch releases focused on core fixes and stability.
|
||||
|
||||
- Numerous core fixes and small adjustments across many patch versions.
|
||||
- General maintenance: bug fixes, internal updates and stability improvements.
|
||||
|
||||
## 2022-03-25 - 2.1.17 - BREAKING(core)
|
||||
Switched module format to ESM (breaking).
|
||||
|
||||
- BREAKING CHANGE: project now uses ESM module format.
|
||||
- Release includes the version bump and migration to ESM.
|
||||
|
||||
## 2019-11-28 - 2.0.16 - feat(taskrunner)
|
||||
Introduce a working task runner.
|
||||
|
||||
- Added/activated a working taskrunner implementation.
|
||||
- Improvements to task execution and orchestration.
|
||||
|
||||
## 2019-09-05 to 2022-11-14 - 2.0.3..2.1.16 - maintenance
|
||||
Ongoing maintenance and incremental fixes between 2.0.x and 2.1.x series.
|
||||
|
||||
- Multiple fixes labeled as core maintenance updates.
|
||||
- CI, packaging and small doc/test fixes rolled out across these releases.
|
||||
|
||||
## 2018-08-04 - 2.0.0 - major
|
||||
Major release and scope change with CI/test updates.
|
||||
|
||||
- Released 2.0.0 with updated docs.
|
||||
- BREAKING CHANGE: package scope switched to @pushrocks (scope migration).
|
||||
- CI and testing updates (moved to new tstest), package.json adjustments.
|
||||
|
||||
## 2017-07-12 - 1.0.21 - enhancements
|
||||
Feature additions around task utilities and manager.
|
||||
|
||||
- Introduced TaskOnce.
|
||||
- Implemented TaskManager (added TaskManager class and improvements across 1.0.10–1.0.16).
|
||||
- Implemented execDelay for tasks.
|
||||
- Documentation and test improvements.
|
||||
|
||||
## 2016-08-03 - 1.0.6 - types
|
||||
Type and promise improvements.
|
||||
|
||||
- Now returns correct Promise types.
|
||||
- Dependency and typings updates.
|
||||
|
||||
## 2016-08-01 - 1.0.0 - stable
|
||||
First stable 1.0.0 release.
|
||||
|
||||
- Exported public interfaces.
|
||||
- Base API stabilized for 1.x line.
|
||||
|
||||
## 2016-05-15 to 2016-05-06 - 0.1.0..0.0.5 - initial features
|
||||
Initial implementation of core task primitives and utilities.
|
||||
|
||||
- Added Taskparallel class to execute tasks in parallel.
|
||||
- Introduced basic Task class and working taskchain.
|
||||
- Added logging and initial task buffering behavior.
|
||||
- Improvements to README, typings and packaging.
|
||||
- Early CI and build setup (Travis/GitLab CI).
|
@@ -7,12 +7,27 @@
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "taskbuffer",
|
||||
"description": "flexible task management. TypeScript ready!",
|
||||
"description": "A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.",
|
||||
"npmPackagename": "@push.rocks/taskbuffer",
|
||||
"license": "MIT"
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"task management",
|
||||
"TypeScript",
|
||||
"task buffering",
|
||||
"task scheduling",
|
||||
"task execution",
|
||||
"task dependencies",
|
||||
"parallel tasks",
|
||||
"task chains",
|
||||
"debounced tasks",
|
||||
"distributed coordination"
|
||||
]
|
||||
}
|
||||
},
|
||||
"tsdoc": {
|
||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||
}
|
||||
}
|
39
package.json
39
package.json
@@ -1,49 +1,53 @@
|
||||
{
|
||||
"name": "@push.rocks/taskbuffer",
|
||||
"version": "3.1.4",
|
||||
"version": "3.1.8",
|
||||
"private": false,
|
||||
"description": "flexible task management. TypeScript ready!",
|
||||
"description": "A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"test": "(tstest test/ --web)",
|
||||
"test": "(tstest test/ --verbose --logfile --timeout 120)",
|
||||
"build": "(tsbuild --web && tsbundle npm)",
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://gitlab.com/pushrocks/taskbuffer.git"
|
||||
"url": "https://code.foss.global/push.rocks/taskbuffer.git"
|
||||
},
|
||||
"keywords": [
|
||||
"gulp",
|
||||
"task",
|
||||
"buffer",
|
||||
"task management",
|
||||
"TypeScript",
|
||||
"push.rocks"
|
||||
"task buffering",
|
||||
"task scheduling",
|
||||
"task execution",
|
||||
"task dependencies",
|
||||
"parallel tasks",
|
||||
"task chains",
|
||||
"debounced tasks",
|
||||
"distributed coordination"
|
||||
],
|
||||
"author": "Lossless GmbH",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://gitlab.com/pushrocks/taskbuffer/issues"
|
||||
},
|
||||
"homepage": "https://gitlab.com/pushrocks/taskbuffer#readme",
|
||||
"homepage": "https://code.foss.global/push.rocks/taskbuffer",
|
||||
"dependencies": {
|
||||
"@push.rocks/lik": "^6.0.5",
|
||||
"@push.rocks/smartdelay": "^3.0.5",
|
||||
"@push.rocks/smartlog": "^3.0.3",
|
||||
"@push.rocks/smartpromise": "^4.0.3",
|
||||
"@push.rocks/smartrx": "^3.0.6",
|
||||
"@push.rocks/smarttime": "^4.0.5",
|
||||
"@push.rocks/smarttime": "^4.0.6",
|
||||
"@push.rocks/smartunique": "^3.0.6"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.1.66",
|
||||
"@gitzone/tsbundle": "^2.0.8",
|
||||
"@gitzone/tsrun": "^1.2.44",
|
||||
"@gitzone/tstest": "^1.0.77",
|
||||
"@push.rocks/tapbundle": "^5.0.15",
|
||||
"@types/node": "^20.5.0"
|
||||
"@git.zone/tsbuild": "^2.1.66",
|
||||
"@git.zone/tsbundle": "^2.0.8",
|
||||
"@git.zone/tsrun": "^1.2.44",
|
||||
"@git.zone/tstest": "^2.3.5",
|
||||
"@types/node": "^20.8.7"
|
||||
},
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
@@ -59,5 +63,6 @@
|
||||
],
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
]
|
||||
],
|
||||
"packageManager": "pnpm@10.14.0+sha512.ad27a79641b49c3e481a16a805baa71817a04bbe06a38d17e60e2eaee83f6a146c6a688125f5792e48dd5ba30e7da52a5cda4c3992b9ccf333f9ce223af84748"
|
||||
}
|
||||
|
11849
pnpm-lock.yaml
generated
11849
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@@ -0,0 +1 @@
|
||||
|
533
readme.md
533
readme.md
@@ -1,61 +1,494 @@
|
||||
# @push.rocks/taskbuffer
|
||||
flexible task management. TypeScript ready!
|
||||
# @push.rocks/taskbuffer 🚀
|
||||
|
||||
## 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/)
|
||||
A **powerful**, **flexible**, and **TypeScript-first** task management library for orchestrating asynchronous operations with style. From simple task execution to complex distributed workflows, taskbuffer has got you covered.
|
||||
|
||||
## Status for master
|
||||
## Install 📦
|
||||
|
||||
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
|
||||
}
|
||||
})
|
||||
```bash
|
||||
npm install @push.rocks/taskbuffer --save
|
||||
```
|
||||
|
||||
For further information read the linked docs at the top of this README.
|
||||
Or with **pnpm** (recommended):
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
```bash
|
||||
pnpm add @push.rocks/taskbuffer
|
||||
```
|
||||
|
||||
[](https://push.rocks)
|
||||
## Why taskbuffer? 🤔
|
||||
|
||||
## Contribution
|
||||
In the modern JavaScript ecosystem, managing asynchronous tasks efficiently is crucial. Whether you're building a data pipeline, managing API rate limits, or orchestrating complex workflows, **@push.rocks/taskbuffer** provides the tools you need:
|
||||
|
||||
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). :)
|
||||
- **🎯 TypeScript-first**: Built with TypeScript for TypeScript - enjoy complete type safety and excellent IDE support
|
||||
- **⚡ Flexible execution**: From simple tasks to complex parallel workflows with dependencies
|
||||
- **🔄 Smart buffering**: Control concurrent executions with intelligent buffer management
|
||||
- **⏰ Built-in scheduling**: Cron-based task scheduling without additional dependencies
|
||||
- **🎭 Multiple paradigms**: Support for debounced, throttled, and one-time execution patterns
|
||||
- **🔌 Extensible**: Clean architecture that's easy to extend and customize
|
||||
- **🏃 Zero dependencies on external schedulers**: Everything you need is included
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
## Core Concepts 🎓
|
||||
|
||||
## 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)
|
||||
### Task
|
||||
The fundamental unit of work. A task wraps an asynchronous function and provides powerful execution control.
|
||||
|
||||
### Taskchain
|
||||
Sequential task execution - tasks run one after another, with results passed along the chain.
|
||||
|
||||
### Taskparallel
|
||||
Parallel task execution - multiple tasks run simultaneously for maximum performance.
|
||||
|
||||
### TaskManager
|
||||
Centralized task scheduling and management using cron expressions.
|
||||
|
||||
### TaskDebounced
|
||||
Debounced task execution - prevents rapid repeated executions, only running after a quiet period.
|
||||
|
||||
### TaskOnce
|
||||
Singleton task execution - ensures a task runs exactly once, perfect for initialization routines.
|
||||
|
||||
## Quick Start 🏁
|
||||
|
||||
### Basic Task Execution
|
||||
|
||||
```typescript
|
||||
import { Task } from '@push.rocks/taskbuffer';
|
||||
|
||||
// Create a simple task
|
||||
const myTask = new Task({
|
||||
name: 'DataProcessor',
|
||||
taskFunction: async () => {
|
||||
const data = await fetchData();
|
||||
return processData(data);
|
||||
}
|
||||
});
|
||||
|
||||
// Execute the task
|
||||
const result = await myTask.trigger();
|
||||
```
|
||||
|
||||
### Buffered Execution (Rate Limiting)
|
||||
|
||||
Perfect for API calls or database operations that need throttling:
|
||||
|
||||
```typescript
|
||||
const apiTask = new Task({
|
||||
name: 'APICall',
|
||||
taskFunction: async (endpoint: string) => {
|
||||
return await fetch(endpoint);
|
||||
},
|
||||
buffered: true,
|
||||
bufferMax: 3, // Maximum 3 concurrent executions
|
||||
execDelay: 1000 // Wait 1 second between executions
|
||||
});
|
||||
|
||||
// These will be automatically throttled
|
||||
for (let i = 0; i < 10; i++) {
|
||||
apiTask.trigger(`/api/data/${i}`);
|
||||
}
|
||||
```
|
||||
|
||||
### Task Chains - Sequential Workflows
|
||||
|
||||
Build complex workflows where each step depends on the previous:
|
||||
|
||||
```typescript
|
||||
import { Task, Taskchain } from '@push.rocks/taskbuffer';
|
||||
|
||||
const fetchTask = new Task({
|
||||
name: 'FetchData',
|
||||
taskFunction: async () => {
|
||||
const response = await fetch('/api/data');
|
||||
return response.json();
|
||||
}
|
||||
});
|
||||
|
||||
const transformTask = new Task({
|
||||
name: 'TransformData',
|
||||
taskFunction: async (data) => {
|
||||
return data.map(item => ({
|
||||
...item,
|
||||
processed: true,
|
||||
timestamp: Date.now()
|
||||
}));
|
||||
}
|
||||
});
|
||||
|
||||
const saveTask = new Task({
|
||||
name: 'SaveData',
|
||||
taskFunction: async (transformedData) => {
|
||||
await database.bulkInsert(transformedData);
|
||||
return { saved: transformedData.length };
|
||||
}
|
||||
});
|
||||
|
||||
const workflow = new Taskchain({
|
||||
name: 'DataPipeline',
|
||||
taskArray: [fetchTask, transformTask, saveTask]
|
||||
});
|
||||
|
||||
// Execute the entire chain
|
||||
const result = await workflow.trigger();
|
||||
console.log(`Processed ${result.saved} items`);
|
||||
```
|
||||
|
||||
### Parallel Execution - Maximum Performance
|
||||
|
||||
Execute multiple independent tasks simultaneously:
|
||||
|
||||
```typescript
|
||||
import { Task, Taskparallel } from '@push.rocks/taskbuffer';
|
||||
|
||||
const tasks = ['user', 'posts', 'comments'].map(resource =>
|
||||
new Task({
|
||||
name: `Fetch${resource}`,
|
||||
taskFunction: async () => {
|
||||
const data = await fetch(`/api/${resource}`);
|
||||
return data.json();
|
||||
}
|
||||
})
|
||||
);
|
||||
|
||||
const parallelFetch = new Taskparallel({
|
||||
taskArray: tasks
|
||||
});
|
||||
|
||||
// All tasks execute simultaneously
|
||||
const [users, posts, comments] = await parallelFetch.trigger();
|
||||
```
|
||||
|
||||
### Scheduled Tasks with TaskManager
|
||||
|
||||
Run tasks on a schedule using cron expressions:
|
||||
|
||||
```typescript
|
||||
import { Task, TaskManager } from '@push.rocks/taskbuffer';
|
||||
|
||||
const backupTask = new Task({
|
||||
name: 'DatabaseBackup',
|
||||
taskFunction: async () => {
|
||||
await performBackup();
|
||||
console.log(`Backup completed at ${new Date().toISOString()}`);
|
||||
}
|
||||
});
|
||||
|
||||
const manager = new TaskManager();
|
||||
|
||||
// Add and schedule tasks
|
||||
manager.addAndScheduleTask(backupTask, '0 0 * * *'); // Daily at midnight
|
||||
manager.addAndScheduleTask(healthCheck, '*/5 * * * *'); // Every 5 minutes
|
||||
|
||||
// Start the scheduler
|
||||
manager.start();
|
||||
|
||||
// Later... stop if needed
|
||||
manager.stop();
|
||||
```
|
||||
|
||||
### Debounced Tasks - Smart Throttling
|
||||
|
||||
Prevent task spam with intelligent debouncing:
|
||||
|
||||
```typescript
|
||||
import { TaskDebounced } from '@push.rocks/taskbuffer';
|
||||
|
||||
const saveTask = new TaskDebounced({
|
||||
name: 'AutoSave',
|
||||
taskFunction: async (content: string) => {
|
||||
await saveToDatabase(content);
|
||||
console.log('Content saved');
|
||||
},
|
||||
debounceTimeInMillis: 2000 // Wait 2 seconds of inactivity
|
||||
});
|
||||
|
||||
// Rapid calls will be debounced
|
||||
input.addEventListener('input', (e) => {
|
||||
saveTask.trigger(e.target.value);
|
||||
});
|
||||
```
|
||||
|
||||
### One-Time Tasks - Initialize Once
|
||||
|
||||
Ensure initialization code runs exactly once:
|
||||
|
||||
```typescript
|
||||
import { TaskOnce } from '@push.rocks/taskbuffer';
|
||||
|
||||
const initTask = new TaskOnce({
|
||||
name: 'SystemInitialization',
|
||||
taskFunction: async () => {
|
||||
await database.connect();
|
||||
await cache.initialize();
|
||||
await loadConfiguration();
|
||||
console.log('System initialized');
|
||||
}
|
||||
});
|
||||
|
||||
// Safe to call multiple times - only runs once
|
||||
await initTask.trigger();
|
||||
await initTask.trigger(); // This won't run again
|
||||
```
|
||||
|
||||
## Advanced Features 🔥
|
||||
|
||||
### Task Dependencies with Pre/Post Hooks
|
||||
|
||||
Create sophisticated task relationships:
|
||||
|
||||
```typescript
|
||||
const validationTask = new Task({
|
||||
name: 'ValidateInput',
|
||||
taskFunction: async (data) => {
|
||||
if (!isValid(data)) {
|
||||
throw new Error('Validation failed');
|
||||
}
|
||||
return data;
|
||||
}
|
||||
});
|
||||
|
||||
const mainTask = new Task({
|
||||
name: 'ProcessData',
|
||||
taskFunction: async (data) => {
|
||||
return await complexProcessing(data);
|
||||
},
|
||||
preTask: validationTask, // Runs before main task
|
||||
afterTask: cleanupTask // Runs after main task
|
||||
});
|
||||
```
|
||||
|
||||
### Task Runners - Distributed Execution
|
||||
|
||||
The TaskRunner system enables distributed task execution across multiple workers:
|
||||
|
||||
```typescript
|
||||
import { TaskRunner } from '@push.rocks/taskbuffer';
|
||||
|
||||
const runner = new TaskRunner({
|
||||
name: 'WorkerNode1',
|
||||
maxConcurrentTasks: 5
|
||||
});
|
||||
|
||||
// Register tasks this runner can handle
|
||||
runner.registerTask(dataProcessingTask);
|
||||
runner.registerTask(imageResizeTask);
|
||||
|
||||
// Start processing
|
||||
runner.start();
|
||||
```
|
||||
|
||||
### Buffer Management Strategies
|
||||
|
||||
Fine-tune concurrent execution behavior:
|
||||
|
||||
```typescript
|
||||
const task = new Task({
|
||||
name: 'ResourceIntensive',
|
||||
taskFunction: async () => { /* ... */ },
|
||||
buffered: true,
|
||||
bufferMax: 5, // Max 5 concurrent
|
||||
execDelay: 100, // 100ms between starts
|
||||
timeout: 30000 // 30 second timeout
|
||||
});
|
||||
```
|
||||
|
||||
### Cycle Detection and Prevention
|
||||
|
||||
TaskBuffer automatically detects and prevents circular dependencies:
|
||||
|
||||
```typescript
|
||||
const taskA = new Task({
|
||||
name: 'TaskA',
|
||||
taskFunction: async () => { /* ... */ },
|
||||
preTask: taskB // This would create a cycle
|
||||
});
|
||||
|
||||
const taskB = new Task({
|
||||
name: 'TaskB',
|
||||
taskFunction: async () => { /* ... */ },
|
||||
preTask: taskA // Circular dependency detected!
|
||||
});
|
||||
```
|
||||
|
||||
### Dynamic Task Creation
|
||||
|
||||
Create tasks on-the-fly based on runtime conditions:
|
||||
|
||||
```typescript
|
||||
const dynamicWorkflow = async (config: Config) => {
|
||||
const tasks = config.steps.map(step =>
|
||||
new Task({
|
||||
name: step.name,
|
||||
taskFunction: async (input) => {
|
||||
return await processStep(step, input);
|
||||
}
|
||||
})
|
||||
);
|
||||
|
||||
const chain = new Taskchain({
|
||||
name: 'DynamicWorkflow',
|
||||
taskArray: tasks
|
||||
});
|
||||
|
||||
return await chain.trigger();
|
||||
};
|
||||
```
|
||||
|
||||
## API Reference 📚
|
||||
|
||||
### Task Options
|
||||
|
||||
| Option | Type | Description |
|
||||
|--------|------|-------------|
|
||||
| `name` | `string` | Unique identifier for the task |
|
||||
| `taskFunction` | `Function` | Async function to execute |
|
||||
| `buffered` | `boolean` | Enable buffer management |
|
||||
| `bufferMax` | `number` | Maximum concurrent executions |
|
||||
| `execDelay` | `number` | Delay between executions (ms) |
|
||||
| `timeout` | `number` | Task timeout (ms) |
|
||||
| `preTask` | `Task` | Task to run before |
|
||||
| `afterTask` | `Task` | Task to run after |
|
||||
|
||||
### TaskManager Methods
|
||||
|
||||
| Method | Description |
|
||||
|--------|-------------|
|
||||
| `addTask(task, cronExpression)` | Add and schedule a task |
|
||||
| `removeTask(taskName)` | Remove a scheduled task |
|
||||
| `start()` | Start the scheduler |
|
||||
| `stop()` | Stop the scheduler |
|
||||
| `getStats()` | Get execution statistics |
|
||||
|
||||
### Taskchain Methods
|
||||
|
||||
| Method | Description |
|
||||
|--------|-------------|
|
||||
| `addTask(task)` | Add task to chain |
|
||||
| `removeTask(taskName)` | Remove task from chain |
|
||||
| `trigger(initialValue)` | Execute the chain |
|
||||
| `reset()` | Reset chain state |
|
||||
|
||||
## Performance Tips 🏎️
|
||||
|
||||
1. **Use buffering for I/O operations**: Prevents overwhelming external services
|
||||
2. **Leverage parallel execution**: When tasks are independent, run them simultaneously
|
||||
3. **Implement proper error handling**: Use try-catch in task functions
|
||||
4. **Monitor task execution**: Use the built-in stats and logging
|
||||
5. **Set appropriate timeouts**: Prevent hanging tasks from blocking your system
|
||||
|
||||
## Error Handling 🛡️
|
||||
|
||||
```typescript
|
||||
const robustTask = new Task({
|
||||
name: 'RobustOperation',
|
||||
taskFunction: async (input) => {
|
||||
try {
|
||||
return await riskyOperation(input);
|
||||
} catch (error) {
|
||||
// Log error
|
||||
console.error(`Task failed: ${error.message}`);
|
||||
|
||||
// Optionally retry
|
||||
if (error.retryable) {
|
||||
return await riskyOperation(input);
|
||||
}
|
||||
|
||||
// Or return default value
|
||||
return defaultValue;
|
||||
}
|
||||
},
|
||||
timeout: 5000 // Fail if takes longer than 5 seconds
|
||||
});
|
||||
```
|
||||
|
||||
## Real-World Examples 🌍
|
||||
|
||||
### API Rate Limiting
|
||||
|
||||
```typescript
|
||||
const apiClient = new Task({
|
||||
name: 'RateLimitedAPI',
|
||||
taskFunction: async (endpoint: string) => {
|
||||
return await fetch(`https://api.example.com${endpoint}`);
|
||||
},
|
||||
buffered: true,
|
||||
bufferMax: 10, // 10 requests
|
||||
execDelay: 100 // Per 100ms = 100 req/s max
|
||||
});
|
||||
```
|
||||
|
||||
### Database Migration Pipeline
|
||||
|
||||
```typescript
|
||||
const migrationChain = new Taskchain({
|
||||
name: 'DatabaseMigration',
|
||||
taskArray: [
|
||||
backupTask,
|
||||
schemaUpdateTask,
|
||||
dataTransformTask,
|
||||
validationTask,
|
||||
cleanupTask
|
||||
]
|
||||
});
|
||||
```
|
||||
|
||||
### Microservice Health Monitoring
|
||||
|
||||
```typescript
|
||||
const healthMonitor = new TaskManager();
|
||||
|
||||
services.forEach(service => {
|
||||
const healthCheck = new Task({
|
||||
name: `HealthCheck:${service.name}`,
|
||||
taskFunction: async () => {
|
||||
const healthy = await checkHealth(service.url);
|
||||
if (!healthy) {
|
||||
await alertOps(service);
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
healthMonitor.addAndScheduleTask(healthCheck, '*/1 * * * *'); // Every minute
|
||||
});
|
||||
```
|
||||
|
||||
## Testing 🧪
|
||||
|
||||
```typescript
|
||||
import { expect, tap } from '@git.zone/tstest';
|
||||
import { Task } from '@push.rocks/taskbuffer';
|
||||
|
||||
tap.test('should execute task successfully', async () => {
|
||||
const result = await myTask.trigger();
|
||||
expect(result).toEqual(expectedValue);
|
||||
});
|
||||
|
||||
tap.start();
|
||||
```
|
||||
|
||||
## Contributing 🤝
|
||||
|
||||
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
|
||||
|
||||
## Support 💬
|
||||
|
||||
- 📧 Email: [hello@task.vc](mailto:hello@task.vc)
|
||||
- 🐛 Issues: [GitHub Issues](https://github.com/push-rocks/taskbuffer/issues)
|
||||
- 📖 Docs: [Documentation](https://code.foss.global/push.rocks/taskbuffer)
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||
|
||||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||
|
||||
### Trademarks
|
||||
|
||||
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
||||
|
||||
### Company Information
|
||||
|
||||
Task Venture Capital GmbH
|
||||
Registered at District court Bremen HRB 35230 HB, Germany
|
||||
|
||||
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
||||
|
||||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
@@ -1,4 +1,4 @@
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
import * as smartpromise from '@push.rocks/smartpromise';
|
||||
import * as smartdelay from '@push.rocks/smartdelay';
|
||||
|
@@ -1,4 +1,4 @@
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
|
||||
|
@@ -1,4 +1,4 @@
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
import * as smartdelay from '@push.rocks/smartdelay';
|
||||
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
|
@@ -1,4 +1,4 @@
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
|
@@ -1,4 +1,4 @@
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
|
||||
|
@@ -1,4 +1,4 @@
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
|
||||
|
@@ -1,4 +1,4 @@
|
||||
import { tap, expect } from '@push.rocks/tapbundle';
|
||||
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
|
||||
|
@@ -1,4 +1,4 @@
|
||||
import { tap, expect } from '@push.rocks/tapbundle';
|
||||
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
|
||||
|
@@ -1,4 +1,4 @@
|
||||
import { tap, expect } from '@push.rocks/tapbundle';
|
||||
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
|
||||
|
@@ -1,8 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/taskbuffer',
|
||||
version: '3.1.4',
|
||||
description: 'flexible task management. TypeScript ready!'
|
||||
version: '3.1.8',
|
||||
description: 'A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.'
|
||||
}
|
||||
|
@@ -17,6 +17,7 @@ export interface IDistributedTaskRequest {
|
||||
|
||||
export interface IDistributedTaskRequestResult {
|
||||
submitterId: string;
|
||||
requestResponseId: string;
|
||||
considered: boolean;
|
||||
rank: number;
|
||||
reason: string;
|
||||
|
@@ -3,9 +3,12 @@
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "ES2022",
|
||||
"moduleResolution": "nodenext",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true,
|
||||
}
|
||||
"verbatimModuleSyntax": true
|
||||
},
|
||||
"exclude": [
|
||||
"dist_*/**/*.d.ts"
|
||||
]
|
||||
}
|
||||
|
Reference in New Issue
Block a user