Add notes about delByFunction implementation

actionhero · Apr 5, 2021 · adc8e9f · adc8e9f
1 parent 9680639
commit adc8e9f
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/core/queue.ts b/src/core/queue.ts
@@ -174,6 +174,9 @@ export class Queue extends EventEmitter {
 
   /**
    * delByFunction
+   *  * will delete all jobs in the queue of a certain function/class
+   *  * will not prevent new jobs from being added as this method is running
+   *  * will not delete jobs in the delayed queues
    * @param q - queue to look in
    * @param func - function name to delete any jobs with
    * @param start - optional place to start looking in list (default: beginning of list)