@baiwusanyu/utils-task

中文文档
1.1.2发布于 2024/12/12MITTypeScriptESM + CJS零依赖近 30 天下载 3134

类型

中文使用文档
文档目录7 节
  1. Type
  2. ITask
  3. ITaskQueueHooks
  4. Function
  5. setAsyncTaskList
  6. runAsyncTaskList
  7. runTaskQueue

@baiwusanyu/utils-task

Type

ITask

任务队列实例

export interface ITask {
    // 任务函数
    fn: (...args: any[]) => any
    // 任务函数所需参数
    params: Array<any>
    // 重试次数,默认为0
    retry: number
    // 任务唯一id
    id: number
}

ITaskQueueHooks

任务队列执行钩子对象

export interface ITaskQueueHooks {
    // 所有任务执行完毕时钩子
    onFinished?: () => void
    // 任务执行成功时钩子
    onTaskSucceeded?: (index: number, task: ITask) => void
    // 任务执行失败时钩子
    onTaskFailed?: (index: number, task: ITask) => void
}

Function

setAsyncTaskList

生产一个异步任务列表

参数参数类型默认值说明
taskNumNumber-异步任务数
taskFunc(index: number) => Promise<T>-异步任务函数
返回值返回类型说明
taskListPromise<any>[]任务执行列表

runAsyncTaskList

执行一个异步任务列表

参数参数类型默认值说明
taskNumNumber-异步任务数
taskFunc(index: number) => Promise<Record<any, any> / void>-异步任务函数
返回值返回类型说明
resAwaited<any>[]执行结果列表

runTaskQueue

执行一个异步任务队列,它具有重试机制,当任务执行失败(报错),回重新添加到 队列末尾等待重新执行,一直到执行成功或达到该任务的最大执行次数。

参数参数类型默认值说明
taskQueueArray<ITask>-任务队列
hookITaskQueueHooks-任务队列执行钩子对象
maxRetryNumber5最大重试数量
logBooleantrue是否打印日志
返回值返回类型说明
res{success:number[], fail: number[]}执行结果列表,分别对应执行成功的任务或失败任务的id

版本与发布记录

@baiwusanyu/utils-task 共发布 31 个版本,首次发布于 2023/05/01;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.1.2latest2024/12/121.9 年前
1.1.12024/12/121.9 年前
1.1.02024/12/121.9 年前
1.0.182023/12/282 年前
1.0.172023/12/282 年前
1.0.162023/09/023 年前

关于 @baiwusanyu/utils-task 的常见问题

@baiwusanyu/utils-task 是什么?

类型

如何安装 @baiwusanyu/utils-task?

在项目目录运行 npm install @baiwusanyu/utils-task,或使用 pnpm add / yarn add / bun add。

@baiwusanyu/utils-task 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@baiwusanyu/utils-task 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@baiwusanyu/utils-task 可以商用吗?

@baiwusanyu/utils-task 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@baiwusanyu/utils-task 的下载量有多少?

根据 npm 官方下载统计,@baiwusanyu/utils-task 在 2026/10/08 – 2026/11/06 这 30 天内被下载 3,134 次,日均约 104 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@baiwusanyu/utils-task 还在维护吗?

最新版本 1.1.2 发布于 2024/12/12(1.9 年前);至今共发布 31 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/05/01。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。