@push.rocks/taskbuffer 3.0.11 → 3.0.14

package/ts/taskbuffer.classes.task.ts

@@ -4,20 +4,24 @@ import { CycleCounter } from './taskbuffer.classes.cyclecounter.js';
 
 import { logger } from './taskbuffer.logging.js';
 
-export interface ITaskFunction {
-  (x?: any): PromiseLike<any>;
+export interface ITaskFunction<T = undefined> {
+  (x?: any, setupValue?: T): PromiseLike<any>;
 }
 
-export type TPreOrAfterTaskFunction = () => Task;
+export interface ITaskSetupFunction<T = undefined> {
+  (): Promise<T>;
+}
+
+export type TPreOrAfterTaskFunction = () => Task<any>;
 
-export class Task {
+export class Task<T = undefined> {
   // STATIC
-  public static extractTask(preOrAfterTaskArg: Task | TPreOrAfterTaskFunction): Task {
+  public static extractTask<T = undefined>(preOrAfterTaskArg: Task<T> | TPreOrAfterTaskFunction): Task<T> {
     switch (true) {
       case !preOrAfterTaskArg:
         return null;
       case preOrAfterTaskArg instanceof Task:
-        return preOrAfterTaskArg as Task;
+        return preOrAfterTaskArg as Task<T>;
       case typeof preOrAfterTaskArg === 'function':
         const taskFunction = preOrAfterTaskArg as TPreOrAfterTaskFunction;
         return taskFunction();
@@ -32,7 +36,7 @@ export class Task {
     return done.promise;
   };
 
-  public static isTask = (taskArg: Task): boolean => {
+  public static isTask = (taskArg: Task<any>): boolean => {
     if (taskArg instanceof Task && typeof taskArg.taskFunction === 'function') {
       return true;
     } else {
@@ -40,10 +44,10 @@ export class Task {
     }
   };
 
-  public static isTaskTouched = (
-    taskArg: Task | TPreOrAfterTaskFunction,
-    touchedTasksArray: Task[]
-  ): boolean => {
+  public static isTaskTouched<T = undefined> (
+    taskArg: Task<T> | TPreOrAfterTaskFunction,
+    touchedTasksArray: Task<T>[]
+  ): boolean {
     const taskToCheck = Task.extractTask(taskArg);
     let result = false;
     for (const keyArg in touchedTasksArray) {
@@ -54,42 +58,39 @@ export class Task {
     return result;
   };
 
-  public static runTask = async (
-    taskArg: Task | TPreOrAfterTaskFunction,
-    optionsArg: { x?: any; touchedTasksArray?: Task[] }
+  public static runTask = async <T>(
+    taskArg: Task<T> | TPreOrAfterTaskFunction,
+    optionsArg: { x?: any; touchedTasksArray?: Task<T>[] }
   ) => {
-    // extracts the task in case it is specified as a return value of a function
     const taskToRun = Task.extractTask(taskArg);
     const done = plugins.smartpromise.defer();
 
-    // pay respect to execDelay
+    if (!taskToRun.setupValue && taskToRun.taskSetup) {
+      taskToRun.setupValue = await taskToRun.taskSetup();
+    }
+
     if (taskToRun.execDelay) {
       await plugins.smartdelay.delayFor(taskToRun.execDelay);
     }
 
-    //  set running params
     taskToRun.running = true;
 
     done.promise.then(async () => {
       taskToRun.running = false;
     });
 
-    // handle options
     const options = {
       ...{ x: undefined, touchedTasksArray: [] },
       ...optionsArg,
     };
     const x = options.x;
-    const touchedTasksArray: Task[] = options.touchedTasksArray;
+    const touchedTasksArray: Task<T>[] = options.touchedTasksArray;
 
     touchedTasksArray.push(taskToRun);
 
-    // run the task cascade
     const localDeferred = plugins.smartpromise.defer();
     localDeferred.promise
       .then(() => {
-        // lets run any preTask
-
         if (taskToRun.preTask && !Task.isTaskTouched(taskToRun.preTask, touchedTasksArray)) {
           return Task.runTask(taskToRun.preTask, { x, touchedTasksArray });
         } else {
@@ -99,9 +100,8 @@ export class Task {
         }
       })
       .then(async (x) => {
-        // lets run the main task
         try {
-          return await taskToRun.taskFunction(x);
+          return await taskToRun.taskFunction(x, taskToRun.setupValue);
         } catch (e) {
           console.log(e);
         }
@@ -126,15 +126,9 @@ export class Task {
   };
 
   // INSTANCE
-  // mandatory properties
   public name: string;
-  /**
-   * the version of the task
-   * should follow semver
-   * might be important for DistributedCoordinator
-   */
   public version: string;
-  public taskFunction: ITaskFunction;
+  public taskFunction: ITaskFunction<T>;
   public buffered: boolean;
   public cronJob: plugins.smarttime.CronJob;
 
@@ -142,11 +136,9 @@ export class Task {
   public execDelay: number;
   public timeout: number;
 
-  // tasks to run before and after
-  public preTask: Task | TPreOrAfterTaskFunction;
-  public afterTask: Task | TPreOrAfterTaskFunction;
+  public preTask: Task<T> | TPreOrAfterTaskFunction;
+  public afterTask: Task<T> | TPreOrAfterTaskFunction;
 
-  // initialize by default
   public running: boolean = false;
   public bufferRunner = new BufferRunner(this);
   public cycleCounter = new CycleCounter(this);
@@ -154,36 +146,18 @@ export class Task {
   public idle: boolean = true;
   private _state: string = 'ready';
 
+  public taskSetup: ITaskSetupFunction<T>;
+  public setupValue: T;
+
   constructor(optionsArg: {
-    /**
-     * the task function to run, must return promise
-     */
-    taskFunction: ITaskFunction;
-    /**
-     * any other task to run before
-     */
-    preTask?: Task | TPreOrAfterTaskFunction;
-    /**
-     * any other task to run after
-     */
-    afterTask?: Task | TPreOrAfterTaskFunction;
-    /**
-     * wether this task should run buffered
-     */
+    taskFunction: ITaskFunction<T>;
+    preTask?: Task<T> | TPreOrAfterTaskFunction;
+    afterTask?: Task<T> | TPreOrAfterTaskFunction;
     buffered?: boolean;
-    /**
-     * the maximum buffer
-     */
     bufferMax?: number;
-    /**
-     * the execution delay, before the task is executed
-     * only makes sense when running in buffered mode
-     */
     execDelay?: number;
-    /**
-     * the name of the task
-     */
     name?: string;
+    taskSetup?: ITaskSetupFunction<T>;
   }) {
     this.taskFunction = optionsArg.taskFunction;
     this.preTask = optionsArg.preTask;
@@ -193,11 +167,9 @@ export class Task {
     this.bufferMax = optionsArg.bufferMax;
     this.execDelay = optionsArg.execDelay;
     this.name = optionsArg.name;
+    this.taskSetup = optionsArg.taskSetup;
   }
 
-  /**
-   * trigger the task. Will trigger buffered if this.buffered is true
-   */
   public trigger(x?: any): Promise<any> {
     if (this.buffered) {
       return this.triggerBuffered(x);
@@ -206,18 +178,10 @@ export class Task {
     }
   }
 
-  /**
-   * trigger task unbuffered.
-   * will actually run the task, not considering any buffered limits.
-   */
   public triggerUnBuffered(x?: any): Promise<any> {
-    return Task.runTask(this, { x: x });
+    return Task.runTask<T>(this, { x: x });
   }
 
-  /**
-   * trigger task buffered.
-   * note: .trigger() also calls this function
-   */
   public triggerBuffered(x?: any): Promise<any> {
     return this.bufferRunner.trigger(x);
   }

package/ts/taskbuffer.classes.taskdebounced.ts

@@ -1,6 +1,6 @@
 import * as plugins from './taskbuffer.plugins.js';
 
-import { Task, ITaskFunction } from './taskbuffer.classes.task.js';
+import { Task, type ITaskFunction } from './taskbuffer.classes.task.js';
 
 export class TaskDebounced<T = unknown> extends Task {
   private _debouncedTaskFunction: ITaskFunction;

package/ts/taskbuffer.classes.taskonce.ts

@@ -1,6 +1,6 @@
 import * as plugins from './taskbuffer.plugins.js';
 
-import { Task, ITaskFunction } from './taskbuffer.classes.task.js';
+import { Task, type ITaskFunction } from './taskbuffer.classes.task.js';
 
 /**
  * TaskOnce is run exactly once, no matter how often it is triggered