@pisell/core 0.0.2

package/lib/tasks/index.d.ts

@@ -0,0 +1,127 @@
+import { Task, TasksModule, RunTaskParams, AddTaskParams, DeleteTaskParams } from "./type";
+import App from "../app";
+export declare class TasksManager {
+    private static instance;
+    private taskFunctions;
+    private tasks;
+    private app;
+    private db;
+    useTasks: () => {
+        tasks: TasksModule;
+    };
+    watchTaskCallback: (taskModule: TasksModule) => void;
+    private timerIds;
+    constructor(app: App);
+    static getInstance(app?: App): TasksManager;
+    addTaskFunction<T>(name: string, fun: T): void;
+    addTaskFunctions<T>(tasks: {
+        name: string;
+        fun: T;
+    }[]): void;
+    getTasks(): TasksModule;
+    getTaskFunction(name: string): any;
+    init(): Promise<void>;
+    private saveTaskQueueToLocal;
+    private loadTaskQueueFromLocal;
+    /**
+     * @title: 执行任务
+     * @description:
+     * @param {Task} task
+     * @return {*}
+     * @Author: zhiwei.Wang
+     * @Date: 2024-09-26 13:53
+     */
+    private runTask;
+    /**
+     * @title: 清除任务定时器
+     */
+    private clearTaskTimer;
+    /**
+     * @title: 计算下一次执行时间
+     * @description: 根据定时任务配置计算下一次执行时间
+     * @param {Task} task
+     * @return {string | null} 下一次执行时间
+     */
+    private calculateNextExecuteTime;
+    /**
+     * @title: 启动定时任务
+     * @description: 在特定时间点执行任务（仅在 scheduledTasks 模块中生效）
+     * @param {Task} task
+     * @return {*}
+     */
+    private startScheduledTask;
+    /**
+     * @title: 启动轮询
+     * @description: 根据轮询间隔定期执行任务
+     * @param {Task} task
+     * @return {*}
+     */
+    private startPolling;
+    /**
+     * @title: 创建任务数据
+     * @description:
+     * @param {Partial} payload
+     * @return {*}
+     * @Author: zhiwei.Wang
+     * @Date: 2024-09-26 13:54
+     */
+    private createTaskData;
+    private getTaskQueue;
+    private timeout;
+    /**
+     * @title: 执行任务队列
+     * @description:
+     * @return {*}
+     * @Author: zhiwei.Wang
+     * @Date: 2024-09-26 13:52
+     */
+    run(payload: RunTaskParams): Promise<void>;
+    deleteTask(payload: DeleteTaskParams): void;
+    /**
+     * @title: 重试任务
+     * @description:
+     * @return {*}
+     * @Author: zhiwei.Wang
+     * @Date: 2024-09-26 13:53
+     */
+    retryTask(payload: RunTaskParams): void;
+    addTask(payload: AddTaskParams): void;
+    private updateTask;
+    private updateQueueStatus;
+    /**
+     * @title: 更新队列运行状态
+     * @description: 标记队列是否正在执行
+     */
+    private updateQueueRunningState;
+    private setTasksData;
+    private setTasks;
+    clearAllTaskTimer(tasks: Task[]): void;
+    clearTasks(payload: RunTaskParams): void;
+    clearAllTasks(): void;
+    watchTask(callback: (taskModule: TasksModule) => void): void;
+    /**
+     * @title: 获取队列执行状态
+     * @description: 获取指定队列的执行状态和进度信息
+     * @param {string} module - 模块名
+     * @param {string} queueId - 队列ID
+     * @return {object} 队列状态信息
+     */
+    getQueueStatus(module: string, queueId: string): {
+        isRunning: boolean;
+        status: "uncompleted" | "completed";
+        progress: {
+            total: number;
+            completed: number;
+            failed: number;
+            inProgress: number;
+        };
+        lastRunAt: string | null;
+        tasksCount: number;
+    } | null;
+    /**
+     * @title: 获取所有队列状态
+     * @description: 获取所有任务队列的执行状态概览
+     * @return {object} 所有队列的状态信息
+     */
+    getAllQueuesStatus(): any;
+}