{"id":17801567,"url":"https://github.com/yiminghe/concurrent-runner","last_synced_at":"2025-06-26T03:31:06.765Z","repository":{"id":57205218,"uuid":"452202738","full_name":"yiminghe/concurrent-runner","owner":"yiminghe","description":"run cancelable async function concurrently by concurrency and priority using heap","archived":false,"fork":false,"pushed_at":"2022-08-05T18:33:06.000Z","size":180,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-05T04:41:21.114Z","etag":null,"topics":["async","cancelable","concurrency","priority","promise"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yiminghe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-01-26T08:50:34.000Z","updated_at":"2023-04-11T15:38:58.000Z","dependencies_parsed_at":"2022-09-18T00:50:46.740Z","dependency_job_id":null,"html_url":"https://github.com/yiminghe/concurrent-runner","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/yiminghe/concurrent-runner","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yiminghe%2Fconcurrent-runner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yiminghe%2Fconcurrent-runner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yiminghe%2Fconcurrent-runner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yiminghe%2Fconcurrent-runner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yiminghe","download_url":"https://codeload.github.com/yiminghe/concurrent-runner/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yiminghe%2Fconcurrent-runner/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261993995,"owners_count":23241921,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["async","cancelable","concurrency","priority","promise"],"created_at":"2024-10-27T12:38:52.463Z","updated_at":"2025-06-26T03:31:06.184Z","avatar_url":"https://github.com/yiminghe.png","language":"TypeScript","readme":"# concurrent-runner\n\n[![NPM version](https://badge.fury.io/js/concurrent-runner.png)](http://badge.fury.io/js/concurrent-runner)\n[![NPM downloads](http://img.shields.io/npm/dm/concurrent-runner.svg)](https://npmjs.org/package/concurrent-runner)\n[![Build Status](https://app.travis-ci.com/yiminghe/concurrent-runner.svg?branch=main)](https://app.travis-ci.com/github/yiminghe/concurrent-runner)\n\nrun cancelable async function concurrently by concurrency and priority using heap\n\n\n## API\n\n```ts\nexport interface Task\u003cT = any\u003e {\n    run: () =\u003e {\n        promise: Promise\u003cT\u003e;\n        cancel?: () =\u003e void;\n    };\n}\n\nexport type ExtractTaskResult\u003cT\u003e = T extends Task\u003cinfer U\u003e ? U : never;\n\n/**\n * -1 means higher priority\n */\nexport type Comparator\u003cT extends Task = Task\u003e = (t1: T, t2: T) =\u003e -1 | 0 | 1;\n\nexport type TaskHandle\u003cT\u003e = {\n    promise: Promise\u003cT\u003e;\n    cancel: () =\u003e void;\n};\n\nexport interface RunnerOptions\u003cT extends Task = Task\u003e {\n    concurrency: number;\n    comparator: Comparator\u003cT\u003e;\n    onEmpty?: () =\u003e void;\n    onTaskStart?: (o: {\n        task: T;\n    }) =\u003e void;\n    onTaskEnd?: (o: {\n        task: T;\n        result: any;\n    }) =\u003e void;\n}\n\nexport default class CocurrentRunner\u003cT extends Task\u003e {\n    private options;\n    private heap;\n    private running;\n    private started;\n    private paused;\n    constructor(options: RunnerOptions\u003cT\u003e);\n    setOptions(options: Partial\u003cRunnerOptions\u003cT\u003e\u003e): void;\n    start(): void;\n    pause(): void;\n    resume(): void;\n    stop(): void;\n    private endAndSchedule;\n    private checkAndSchedule;\n    addTask\u003cTT extends T, R = ExtractTaskResult\u003cTT\u003e\u003e(task: TT): TaskHandle\u003cR\u003e;\n}\n```\n\n## Usage\n\n```ts\nimport CoRunner, { Task } from 'concurrent-runner';\n\ndescribe(\"concurrent runner\", () =\u003e {\n  interface TimeTask\u003cU = any\u003e extends Task\u003cU\u003e {\n    time: number;\n  }\n  \n  function timeout(d: number): Promise\u003cnumber\u003e {\n    return new Promise((resolve) =\u003e {\n      setTimeout(() =\u003e {\n        resolve(d);\n      }, d);\n    });\n  }\n  \n  function eq(r1: number, r3: number) {\n    return Math.abs(r1 - r3) \u003c 20;\n  }\n\n  function getRunner() {\n    const r = new CoRunner\u003cTimeTask\u003e({\n      concurrency: 2,\n      comparator(t: TimeTask, t2: TimeTask) {\n        return t.time === t2.time ? 0 : t.time \u003e t2.time ? 1 : -1;\n      },\n    });\n    return r;\n  }\n  function getRunnerWithTasks() {\n    const r = getRunner();\n    const ret: number[][] = [];\n    const taskHandles = [];\n    const times = [300, 100, 500, 100];\n    for (let time = 0; time \u003c times.length; time++) {\n      const p = r.addTask({\n        run() {\n          return {\n            promise: timeout(times[time]),\n          };\n        },\n        time,\n      });\n      taskHandles.push(p);\n      p.promise.then(\n        (r) =\u003e {\n          ret.push([time, r]);\n        },\n        (r) =\u003e {\n          ret.push([time, r]);\n        }\n      );\n    }\n    return { r, ret, taskHandles };\n  }\n\n  it(\"works for concurrency\", (done) =\u003e {\n    const { r, ret } = getRunnerWithTasks();\n    const startTime: number[][] = [];\n    const start = Date.now();\n\n    r.setOptions({\n      onTaskStart(info) {\n        startTime.push([info.task.time, Date.now() - start]);\n      },\n      onEmpty() {\n        expect(eq(startTime[2][1], 100)).toBe(true);\n        expect(eq(startTime[3][1], 300)).toBe(true);\n        expect(startTime.map((r) =\u003e r[0])).toEqual([0, 1, 2, 3]);\n        expect(ret.map((r) =\u003e r[0])).toEqual([1, 0, 3, 2]);\n\n        done();\n      },\n    });\n\n    r.start();\n  });\n\n  it(\"can cancel running\", (done) =\u003e {\n    const { r, ret, taskHandles } = getRunnerWithTasks();\n    const startTime: number[][] = [];\n    const start = Date.now();\n\n    setTimeout(() =\u003e {\n      taskHandles[2].cancel();\n    }, 200);\n\n    r.setOptions({\n      onTaskStart(info) {\n        startTime.push([info.task.time, Date.now() - start]);\n      },\n      onEmpty() {\n        expect(eq(startTime[2][1], 100)).toBe(true);\n        expect(eq(startTime[3][1], 200)).toBe(true);\n        expect(startTime.map((r) =\u003e r[0])).toEqual([0, 1, 2, 3]);\n        expect(ret.map((r) =\u003e r[0])).toEqual([1, 2, 0, 3]);\n        expect((ret[1][1] as any).name).toEqual(\"ConcurrentRunnerAbortError\");\n        done();\n      },\n    });\n\n    r.start();\n  });\n\n  it(\"can cancel waiting\", (done) =\u003e {\n    const { r, ret, taskHandles } = getRunnerWithTasks();\n    const startTime: number[][] = [];\n    const start = Date.now();\n\n    setTimeout(() =\u003e {\n      taskHandles[3].cancel();\n    }, 200);\n\n    r.setOptions({\n      onTaskStart(info) {\n        startTime.push([info.task.time, Date.now() - start]);\n      },\n      onEmpty() {\n        expect(eq(startTime[2][1], 100)).toBe(true);\n        expect(startTime.map((r) =\u003e r[0])).toEqual([0, 1, 2]);\n        expect(ret.map((r) =\u003e r[0])).toEqual([1, 3, 0, 2]);\n        expect((ret[1][1] as any).name).toEqual(\"ConcurrentRunnerAbortError\");\n        done();\n      },\n    });\n\n    r.start();\n  });\n\n  function runWithCancel(fn: (...args: any) =\u003e Generator, ...args: any[]): { promise: Promise\u003cany\u003e; cancel: () =\u003e void; } {\n    const gen = fn(...args);\n    let cancelled: boolean, cancel: () =\u003e void = function () { };\n    const promise = new Promise((resolve, reject) =\u003e {\n      cancel = () =\u003e {\n        cancelled = true;\n      };\n\n      onFulfilled();\n\n      function onFulfilled(res?: any) {\n        if (!cancelled) {\n          let result: any;\n          try {\n            result = gen.next(res);\n          } catch (e) {\n            return reject(e);\n          }\n          next(result);\n          return null;\n        }\n      }\n\n      function onRejected(err: any) {\n        var result: any;\n        try {\n          result = gen.throw(err);\n        } catch (e) {\n          return reject(e);\n        }\n        next(result);\n      }\n\n      function next({ done, value }: any) {\n        if (done) {\n          return resolve(value);\n        }\n        return value.then(onFulfilled, onRejected);\n      }\n    });\n\n    return { promise, cancel };\n  }\n\n  function getCancelableRunner() {\n    const r = getRunner();\n    const ret: any[] = [];\n    const ret2: any[] = [];\n\n    const p = r.addTask({\n      run() {\n        return runWithCancel(function* r() {\n          ret2.push(1);\n          yield timeout(200);\n          ret2.push(2);\n          yield timeout(300);\n          ret2.push(3);\n          return 4;\n        });\n      },\n      time: 1,\n    });\n    p.promise.then(\n      (r) =\u003e {\n        ret.push(r);\n      },\n      (r) =\u003e {\n        ret.push(r);\n      }\n    );\n    return { r, p,ret, ret2 };\n  }\n\n  it('do not call cancel', (done) =\u003e {\n    const { r, ret, ret2 } = getCancelableRunner();\n    r.setOptions({\n      onEmpty() {\n        expect(ret).toEqual([4]);\n        expect(ret2).toEqual([1,2,3]);\n        done();\n      }\n    })\n    r.start();\n  });\n\n  it('call task cancel', (done) =\u003e {\n    const { r,p, ret, ret2 } = getCancelableRunner();\n    r.setOptions({\n      onEmpty() {\n        expect(ret.length).toEqual(1);\n        expect(ret[0].name).toEqual('ConcurrentRunnerAbortError');\n        expect(ret2).toEqual([1,2]);\n        done();\n      }\n    })\n    r.start();\n    setTimeout(() =\u003e {\n      p.cancel();\n    }, 300);\n  });\n});\n```\n\n## HISTORY\n\n### 0.2.0 - 2022/02/10\n\n- change CancelablePromise return type to TaskHandle\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyiminghe%2Fconcurrent-runner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyiminghe%2Fconcurrent-runner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyiminghe%2Fconcurrent-runner/lists"}