https://github.com/nucliweb/taskflow-defer
https://github.com/nucliweb/taskflow-defer
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nucliweb/taskflow-defer
- Owner: nucliweb
- Created: 2024-11-06T00:28:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-06T16:57:10.000Z (over 1 year ago)
- Last Synced: 2025-01-16T21:16:45.947Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://taskflow-defer-demo.vercel.app
- Size: 137 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Taskflow Defer
A lightweight library for managing task execution timing in the browser
## Demo
Check out the live demo: [https://taskflow-defer-demo.vercel.app](https://taskflow-defer-demo.vercel.app)
## Installation
```bash
npm install taskflow-defer
# or
pnpm add taskflow-defer
# or
yarn add taskflow-defer
```
## Usage
```typescript
import { delayTask, delayTaskUntilUrgent } from "taskflow-defer";
// Delay a task
await delayTask();
heavyComputation();
// Or delay until browser is idle
await delayTaskUntilUrgent();
heavyComputation();
```
## Local Development
```bash
# Install dependencies
pnpm install
# Run tests
pnpm test
# Run demo
pnpm demo
```
## License
MIT