27 lines
1.1 KiB
Markdown
27 lines
1.1 KiB
Markdown
|
# 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
|