# protask

**Repository Path**: partic/protask

## Basic Information

- **Project Name**: protask
- **Description**: Generator based task library. With cancelable task and task local support.
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-10-18
- **Last Updated**: 2025-04-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README




"**protask**" is a library to manage tasks.

You can abort a task, or access "task local" (like thread local in Java) like below

**Not well tested, use at your own risk.**


### Usage


``` typescript
import { Task } from 'protask';


function sleep<T>(milliSeconds: number, arg?: T): Promise<T> {
    return new Promise(function (resolve, reject) {
        setTimeout(resolve, milliSeconds, arg);
    });
}

function *printTaskLocal() {
    yield* Task.yieldWrap(sleep(100));
    console.info(Task.locals());
}

let task1=Task.fork(function *(){
    try {
        Task.locals()!.taskName='task 1';
        yield* printTaskLocal();
        for (let i = 0; i < 100; i++) {
            Task.locals()!.count = i;
            console.log('task 1 running');
            yield* printTaskLocal();
            yield* Task.yieldWrap(sleep(1000));
        }
        console.log('Task 1 resolve');
    } catch (e: any) {
        console.log('Task 1 error');
        console.info(e.toString());
    } finally {
        console.log('Task 1 finally');
    }
}).run();

let task2=Task.fork(function*(){
    yield* Task.yieldWrap(sleep(3000));
    console.info('abort task 1');
    task1.abort();
}).run();


```


"yieldWrap" is used to make typescript identifying the return value of a Promise.  
"Task.fork" to create a new child task.

"awaitWrap" was existed on 2.x version. But it's impossible to use native await in Task safely, until javascript async-context proposal come true.
So we remove it in 3.x.

### NPM Install 

```sh
npm i protask
```

### Note
protask 1.x hook the Promise to implement Task inheritation.But it work incorrectly in many case.

So 2.x+ version use generator and custom scheduler instead. But it's not compatible with native async/await mechanism. Maybe a source convert like babel should also provide.