poolifier 5.1.6 → 5.2.0

package/lib/index.d.ts

@@ -15,7 +15,9 @@ declare class CircularBuffer {
     private readIdx;
     private writeIdx;
     /**
-     * @param size - Buffer size. @defaultValue defaultBufferSize
+     * CircularBuffer constructor.
+     * @param size - Buffer size.
+     * @defaultValue defaultBufferSize
      * @returns CircularBuffer.
      */
     constructor(size?: number);
@@ -86,11 +88,11 @@ declare const Measurements: Readonly<{
 interface IWorkerChoiceStrategy {
     /**
      * Chooses a worker node in the pool and returns its key.
-     * If no worker nodes are not eligible, `undefined` is returned.
-     * If `undefined` is returned, the caller retry.
+     * If no worker nodes are eligible, `undefined` is returned and the caller retries.
+     * @param workerNodeKeysSet - The worker node keys affinity set. If undefined, all workers are eligible.
      * @returns The worker node key or `undefined`.
      */
-    readonly choose: () => number | undefined;
+    readonly choose: (workerNodeKeysSet?: ReadonlySet<number>) => number | undefined;
     /**
      * The worker choice strategy name.
      */
@@ -274,8 +276,8 @@ interface WorkerOptions {
 
 /**
  * Message object that is passed between main worker and worker.
- * @typeParam Data - Type of data sent to the worker or execution response. This can only be structured-cloneable data.
- * @typeParam ErrorData - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
+ * @template Data - Type of data sent to the worker or execution response. This can only be structured-cloneable data.
+ * @template ErrorData - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
  * @internal
  */
 interface MessageValue<Data = unknown, ErrorData = unknown> extends Task<Data> {
@@ -342,7 +344,7 @@ interface MessageValue<Data = unknown, ErrorData = unknown> extends Task<Data> {
 }
 /**
  * An object holding the task execution response promise resolve/reject callbacks.
- * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
+ * @template Response - Type of execution response. This can only be structured-cloneable data.
  * @internal
  */
 interface PromiseResponseWrapper<Response = unknown> {
@@ -369,7 +371,7 @@ interface PromiseResponseWrapper<Response = unknown> {
 }
 /**
  * Message object that is passed as a task between main worker and worker.
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @template Data - Type of data sent to the worker. This can only be structured-cloneable data.
  * @internal
  */
 interface Task<Data = unknown> {
@@ -423,6 +425,13 @@ interface TaskFunctionProperties {
      * Task function worker choice strategy.
      */
     readonly strategy?: WorkerChoiceStrategy;
+    /**
+     * Task function worker node keys affinity.
+     * Restricts task execution to specified worker nodes by their indices.
+     * Must contain valid indices within [0, pool max size - 1].
+     * If undefined, task can execute on any worker node.
+     */
+    readonly workerNodeKeys?: number[];
 }
 /**
  * Task performance.
@@ -448,7 +457,7 @@ interface TaskPerformance {
 }
 /**
  * Worker error.
- * @typeParam Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
+ * @template Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
  */
 interface WorkerError<Data = unknown> {
     /**
@@ -492,7 +501,7 @@ interface WorkerStatistics {
 }
 /**
  * Remove readonly modifier from all properties of T.
- * @typeParam T - Type to remove readonly modifier.
+ * @template T - Type to remove readonly modifier.
  * @internal
  */
 type Writable<T> = {
@@ -504,21 +513,21 @@ type Writable<T> = {
  * This function must return a promise.
  * @param data - Data sent to the worker.
  * @returns Execution response promise.
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
- * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
+ * @template Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @template Response - Type of execution response. This can only be structured-cloneable data.
  */
 type TaskAsyncFunction<Data = unknown, Response = unknown> = (data?: Data) => Promise<Response>;
 /**
  * Task function that can be executed.
  * This function can be synchronous or asynchronous.
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
- * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
+ * @template Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @template Response - Type of execution response. This can only be structured-cloneable data.
  */
 type TaskFunction<Data = unknown, Response = unknown> = TaskAsyncFunction<Data, Response> | TaskSyncFunction<Data, Response>;
 /**
  * Task function object.
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
- * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
+ * @template Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @template Response - Type of execution response. This can only be structured-cloneable data.
  */
 interface TaskFunctionObject<Data = unknown, Response = unknown> {
     /**
@@ -533,6 +542,13 @@ interface TaskFunctionObject<Data = unknown, Response = unknown> {
      * Task function.
      */
     taskFunction: TaskFunction<Data, Response>;
+    /**
+     * Task function worker node keys affinity.
+     * Restricts task execution to specified worker nodes by their indices.
+     * Must contain valid indices within [0, pool max size - 1].
+     * If undefined, task can execute on any worker node.
+     */
+    workerNodeKeys?: number[];
 }
 /**
  * Task function operation result.
@@ -545,22 +561,22 @@ interface TaskFunctionOperationResult {
  * Tasks functions that can be executed.
  * The key is the name of the task function or task function object.
  * The value is the task function or task function object.
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
- * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
+ * @template Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @template Response - Type of execution response. This can only be structured-cloneable data.
  */
 type TaskFunctions<Data = unknown, Response = unknown> = Record<string, TaskFunction<Data, Response> | TaskFunctionObject<Data, Response>>;
 /**
  * Task synchronous function that can be executed.
  * @param data - Data sent to the worker.
  * @returns Execution response.
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
- * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
+ * @template Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @template Response - Type of execution response. This can only be structured-cloneable data.
  */
 type TaskSyncFunction<Data = unknown, Response = unknown> = (data?: Data) => Response;
 
 /**
  * Priority queue.
- * @typeParam T - Type of priority queue data.
+ * @template T - Type of priority queue data.
  * @internal
  */
 declare class PriorityQueue<T> {
@@ -589,8 +605,10 @@ declare class PriorityQueue<T> {
     private tail;
     /**
      * Constructs a priority queue.
-     * @param bucketSize - Prioritized bucket size. @defaultValue defaultBucketSize
-     * @param enablePriority - Whether to enable priority. @defaultValue false
+     * @param bucketSize - Prioritized bucket size.
+     * @defaultValue defaultBucketSize
+     * @param enablePriority - Whether to enable priority.
+     * @defaultValue false
      * @returns PriorityQueue.
      */
     constructor(bucketSize?: number, enablePriority?: boolean);
@@ -629,27 +647,27 @@ declare class PriorityQueue<T> {
 
 /**
  * Callback invoked if the worker raised an error.
- * @typeParam Worker - Type of worker.
+ * @template Worker - Type of worker.
  */
 type ErrorHandler<Worker extends IWorker> = (this: Worker, error: Error) => void;
 /**
  * Worker event handler.
- * @typeParam Worker - Type of worker.
+ * @template Worker - Type of worker.
  */
 type EventHandler<Worker extends IWorker> = ErrorHandler<Worker> | ExitHandler<Worker> | MessageHandler<Worker> | OnlineHandler<Worker>;
 /**
  * Callback invoked when the worker exits successfully.
- * @typeParam Worker - Type of worker.
+ * @template Worker - Type of worker.
  */
 type ExitHandler<Worker extends IWorker> = (this: Worker, exitCode: number) => void;
 /**
  * Callback invoked if the worker has received a message.
- * @typeParam Worker - Type of worker.
+ * @template Worker - Type of worker.
  */
 type MessageHandler<Worker extends IWorker> = (this: Worker, message: unknown) => void;
 /**
  * Callback invoked when the worker has started successfully.
- * @typeParam Worker - Type of worker.
+ * @template Worker - Type of worker.
  */
 type OnlineHandler<Worker extends IWorker> = (this: Worker) => void;
 /**
@@ -779,8 +797,8 @@ interface IWorker extends EventEmitter {
 }
 /**
  * Worker node interface.
- * @typeParam Worker - Type of worker.
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @template Worker - Type of worker.
+ * @template Data - Type of data sent to the worker. This can only be structured-cloneable data.
  * @internal
  */
 interface IWorkerNode<Worker extends IWorker, Data = unknown> extends EventEmitter {
@@ -807,7 +825,8 @@ interface IWorkerNode<Worker extends IWorker, Data = unknown> extends EventEmitt
     readonly dequeueLastPrioritizedTask: () => Task<Data> | undefined;
     /**
      * Dequeue task.
-     * @param bucket - The prioritized bucket to dequeue from. @defaultValue 0
+     * @param bucket - The prioritized bucket to dequeue from.
+     * @defaultValue 0
      * @returns The dequeued task.
      */
     readonly dequeueTask: (bucket?: number) => Task<Data> | undefined;
@@ -1019,9 +1038,9 @@ declare const PoolEvents: Readonly<{
 }>;
 /**
  * Contract definition for a poolifier pool.
- * @typeParam Worker - Type of worker which manages this pool.
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
- * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
+ * @template Worker - Type of worker which manages this pool.
+ * @template Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @template Response - Type of execution response. This can only be structured-cloneable data.
  */
 interface IPool<Worker extends IWorker, Data = unknown, Response = unknown> {
     /**
@@ -1030,8 +1049,8 @@ interface IPool<Worker extends IWorker, Data = unknown, Response = unknown> {
      * @param name - The name of the task function.
      * @param fn - The task function.
      * @returns `true` if the task function was added, `false` otherwise.
-     * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string.
-     * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `fn` parameter is not a function or task function object.
+     * @throws {TypeError} If the `name` parameter is not a string or an empty string.
+     * @throws {TypeError} If the `fn` parameter is not a function or task function object.
      */
     readonly addTaskFunction: (name: string, fn: TaskFunction<Data, Response> | TaskFunctionObject<Data, Response>) => Promise<boolean>;
     /**
@@ -1206,7 +1225,7 @@ interface PoolInfo {
 }
 /**
  * Options for a poolifier pool.
- * @typeParam Worker - Type of worker.
+ * @template Worker - Type of worker.
  */
 interface PoolOptions<Worker extends IWorker> {
     /**
@@ -1264,7 +1283,7 @@ interface PoolOptions<Worker extends IWorker> {
     tasksQueueOptions?: TasksQueueOptions;
     /**
      * The default worker choice strategy to use in this pool.
-     * @defaultValue WorkerChoiceStrategies.ROUND_ROBIN
+     * @defaultValue WorkerChoiceStrategies.LEAST_USED
      */
     workerChoiceStrategy?: WorkerChoiceStrategy;
     /**
@@ -1315,9 +1334,9 @@ interface TasksQueueOptions {
 
 /**
  * The worker choice strategies context.
- * @typeParam Worker - Type of worker.
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
- * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
+ * @template Worker - Type of worker.
+ * @template Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @template Response - Type of execution response. This can only be structured-cloneable data.
  * @internal
  */
 declare class WorkerChoiceStrategiesContext<Worker extends IWorker, Data = unknown, Response = unknown> {
@@ -1345,17 +1364,19 @@ declare class WorkerChoiceStrategiesContext<Worker extends IWorker, Data = unkno
     /**
      * Worker choice strategies context constructor.
      * @param pool - The pool instance.
-     * @param workerChoiceStrategies - The worker choice strategies. @defaultValue [WorkerChoiceStrategies.ROUND_ROBIN]
+     * @param workerChoiceStrategies - The worker choice strategies.
+     * @defaultValue [WorkerChoiceStrategies.LEAST_USED]
      * @param opts - The worker choice strategy options.
      */
     constructor(pool: IPool<Worker, Data, Response>, workerChoiceStrategies?: WorkerChoiceStrategy[], opts?: WorkerChoiceStrategyOptions);
     /**
-     * Executes the given worker choice strategy in the context algorithm.
-     * @param workerChoiceStrategy - The worker choice strategy algorithm to execute. @defaultValue this.defaultWorkerChoiceStrategy
+     * Executes the given worker choice strategy.
+     * @param workerChoiceStrategy - The worker choice strategy.
+     * @param workerNodeKeysSet - The worker node keys affinity set. If undefined, all workers are eligible.
      * @returns The key of the worker node.
-     * @throws {@link https://nodejs.org/api/errors.html#class-error} If after computed retries the worker node key is null or undefined.
+     * @throws {Error} If after computed retries the worker node key is null or undefined.
      */
-    execute(workerChoiceStrategy?: WorkerChoiceStrategy): number;
+    execute(workerChoiceStrategy?: WorkerChoiceStrategy, workerNodeKeysSet?: ReadonlySet<number>): number;
     /**
      * Gets the active worker choice strategies in the context policy.
      * @returns The strategies policy.
@@ -1409,10 +1430,11 @@ declare class WorkerChoiceStrategiesContext<Worker extends IWorker, Data = unkno
      */
     private addWorkerChoiceStrategy;
     /**
-     * Executes the given worker choice strategy.
-     * @param workerChoiceStrategy - The worker choice strategy.
+     * Executes the given worker choice strategy in the context algorithm.
+     * @param workerChoiceStrategy - The worker choice strategy algorithm to execute.
+     * @param workerNodeKeysSet - The worker node keys affinity set. If undefined, all workers are eligible.
      * @returns The key of the worker node.
-     * @throws {@link https://nodejs.org/api/errors.html#class-error} If after computed retries the worker node key is null or undefined.
+     * @throws {Error} If after computed retries the worker node key is null or undefined.
      */
     private executeStrategy;
     /**
@@ -1425,9 +1447,9 @@ declare class WorkerChoiceStrategiesContext<Worker extends IWorker, Data = unkno
 
 /**
  * Base class that implements some shared logic for all poolifier pools.
- * @typeParam Worker - Type of worker which manages this pool.
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
- * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
+ * @template Worker - Type of worker which manages this pool.
+ * @template Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @template Response - Type of execution response. This can only be structured-cloneable data.
  */
 declare abstract class AbstractPool<Worker extends IWorker, Data = unknown, Response = unknown> implements IPool<Worker, Data, Response> {
     protected readonly minimumNumberOfWorkers: number;
@@ -1670,7 +1692,7 @@ declare abstract class AbstractPool<Worker extends IWorker, Data = unknown, Resp
      * Adds the given worker node in the pool worker nodes.
      * @param workerNode - The worker node.
      * @returns The added worker node key.
-     * @throws {@link https://nodejs.org/api/errors.html#class-error} If the added worker node is not found.
+     * @throws {Error} If the added worker node is not found.
      */
     private addWorkerNode;
     private buildTasksQueueOptions;
@@ -1683,7 +1705,7 @@ declare abstract class AbstractPool<Worker extends IWorker, Data = unknown, Resp
     /**
      * Checks if the worker id sent in the received message from a worker is valid.
      * @param message - The received message.
-     * @throws {@link https://nodejs.org/api/errors.html#class-error} If the worker id is invalid.
+     * @throws {Error} If the worker id is invalid.
      */
     private checkMessageWorkerId;
     private checkMinimumNumberOfWorkers;
@@ -1719,6 +1741,12 @@ declare abstract class AbstractPool<Worker extends IWorker, Data = unknown, Resp
      * @returns The task function worker choice strategy if the task function worker choice strategy is defined, `undefined` otherwise.
      */
     private readonly getTaskFunctionWorkerChoiceStrategy;
+    /**
+     * Gets task function worker node keys affinity set, if any.
+     * @param name - The task function name.
+     * @returns The task function worker node keys affinity set, or `undefined` if not defined.
+     */
+    private readonly getTaskFunctionWorkerNodeKeysSet;
     private getTasksQueuePriority;
     /**
      * Gets the worker choice strategies registered in this pool.
@@ -1791,7 +1819,8 @@ declare abstract class AbstractPool<Worker extends IWorker, Data = unknown, Resp
     private shallUpdateTaskFunctionWorkerUsage;
     /**
      * Starts the minimum number of workers.
-     * @param initWorkerNodeUsage - Whether to initialize the worker node usage or not. @defaultValue false
+     * @param initWorkerNodeUsage - Whether to initialize the worker node usage or not.
+     * @defaultValue false
      */
     private startMinimumNumberOfWorkers;
     private readonly stealTask;
@@ -1809,8 +1838,8 @@ declare abstract class AbstractPool<Worker extends IWorker, Data = unknown, Resp
 type ClusterPoolOptions = PoolOptions<Worker>;
 /**
  * A cluster pool with a fixed number of workers.
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
- * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
+ * @template Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @template Response - Type of execution response. This can only be structured-cloneable data.
  * @author [Christopher Quadflieg](https://github.com/Shinigami92)
  * @since 2.0.0
  */
@@ -1858,8 +1887,8 @@ declare class FixedClusterPool<Data = unknown, Response = unknown> extends Abstr
  *
  * This cluster pool creates new workers when the others are busy, up to the maximum number of workers.
  * When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's `emitter`.
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
- * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
+ * @template Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @template Response - Type of execution response. This can only be structured-cloneable data.
  * @author [Christopher Quadflieg](https://github.com/Shinigami92)
  * @since 2.0.0
  */
@@ -1910,8 +1939,8 @@ declare class DynamicClusterPool<Data = unknown, Response = unknown> extends Fix
 type ThreadPoolOptions = PoolOptions<Worker$1>;
 /**
  * A thread pool with a fixed number of threads.
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
- * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
+ * @template Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @template Response - Type of execution response. This can only be structured-cloneable data.
  * @author [Alessandro Pio Ardizio](https://github.com/pioardi)
  * @since 0.0.1
  */
@@ -1957,8 +1986,8 @@ declare class FixedThreadPool<Data = unknown, Response = unknown> extends Abstra
  *
  * This thread pool creates new threads when the others are busy, up to the maximum number of threads.
  * When the maximum number of threads is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's `emitter`.
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
- * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
+ * @template Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @template Response - Type of execution response. This can only be structured-cloneable data.
  * @author [Alessandro Pio Ardizio](https://github.com/pioardi)
  * @since 0.0.1
  */
@@ -2005,7 +2034,7 @@ declare class DynamicThreadPool<Data = unknown, Response = unknown> extends Fixe
 
 /**
  * Fixed queue node.
- * @typeParam T - Type of fixed queue node data.
+ * @template T - Type of fixed queue node data.
  * @internal
  */
 interface FixedQueueNode<T> {
@@ -2015,7 +2044,7 @@ interface FixedQueueNode<T> {
 }
 /**
  * Fixed queue.
- * @typeParam T - Type of fixed queue data.
+ * @template T - Type of fixed queue data.
  * @internal
  */
 interface IFixedQueue<T> {
@@ -2052,7 +2081,7 @@ interface IFixedQueue<T> {
      * @param data - Data to enqueue.
      * @param priority - Priority of the data. Lower values have higher priority.
      * @returns The new size of the fixed queue.
-     * @throws If the fixed queue is full.
+     * @throws {Error} If the fixed queue is full.
      */
     enqueue: (data: T, priority?: number) => number;
     /**
@@ -2081,9 +2110,9 @@ declare const availableParallelism: () => number;
 
 /**
  * Base class that implements some shared logic for all poolifier workers.
- * @typeParam MainWorker - Type of main worker.
- * @typeParam Data - Type of data this worker receives from pool's execution. This can only be structured-cloneable data.
- * @typeParam Response - Type of response the worker sends back to the main worker. This can only be structured-cloneable data.
+ * @template MainWorker - Type of main worker.
+ * @template Data - Type of data this worker receives from pool's execution. This can only be structured-cloneable data.
+ * @template Response - Type of response the worker sends back to the main worker. This can only be structured-cloneable data.
  */
 declare abstract class AbstractWorker<MainWorker extends MessagePort | Worker, Data = unknown, Response = unknown> {
     protected readonly isMain: boolean | undefined;
@@ -2155,7 +2184,7 @@ declare abstract class AbstractWorker<MainWorker extends MessagePort | Worker, D
     /**
      * Returns the main worker.
      * @returns Reference to the main worker.
-     * @throws {@link https://nodejs.org/api/errors.html#class-error} If the main worker is not set.
+     * @throws {Error} If the main worker is not set.
      */
     protected getMainWorker(): MainWorker;
     /**
@@ -2219,7 +2248,7 @@ declare abstract class AbstractWorker<MainWorker extends MessagePort | Worker, D
     /**
      * Check if the message worker id is set and matches the worker id.
      * @param message - The message to check.
-     * @throws {@link https://nodejs.org/api/errors.html#class-error} If the message worker id is not set or does not match the worker id.
+     * @throws {Error} If the message worker id is not set or does not match the worker id.
      */
     private checkMessageWorkerId;
     /**
@@ -2256,8 +2285,8 @@ declare abstract class AbstractWorker<MainWorker extends MessagePort | Worker, D
  *
  * If you use a `DynamicClusterPool` the extra workers that were created will be terminated,
  * but the minimum number of workers will be guaranteed.
- * @typeParam Data - Type of data this worker receives from pool's execution. This can only be structured-cloneable data.
- * @typeParam Response - Type of response the worker sends back to the main worker. This can only be structured-cloneable data.
+ * @template Data - Type of data this worker receives from pool's execution. This can only be structured-cloneable data.
+ * @template Response - Type of response the worker sends back to the main worker. This can only be structured-cloneable data.
  * @author [Christopher Quadflieg](https://github.com/Shinigami92)
  * @since 2.0.0
  */
@@ -2292,8 +2321,8 @@ declare class ClusterWorker<Data = unknown, Response = unknown> extends Abstract
  *
  * If you use a `DynamicThreadPool` the extra workers that were created will be terminated,
  * but the minimum number of workers will be guaranteed.
- * @typeParam Data - Type of data this worker receives from pool's execution. This can only be structured-cloneable data.
- * @typeParam Response - Type of response the worker sends back to the main thread. This can only be structured-cloneable data.
+ * @template Data - Type of data this worker receives from pool's execution. This can only be structured-cloneable data.
+ * @template Response - Type of response the worker sends back to the main thread. This can only be structured-cloneable data.
  * @author [Alessandro Pio Ardizio](https://github.com/pioardi)
  * @since 0.0.1
  */