poolifier 2.4.7 → 2.4.8

package/lib/pools/abstract-pool.d.ts

@@ -9,7 +9,7 @@ import { WorkerChoiceStrategyContext } from './selection-strategies/worker-choic
  *
  * @typeParam Worker - Type of worker which manages this pool.
  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of response of execution. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
  */
 export declare abstract class AbstractPool<Worker extends IWorker, Data = unknown, Response = unknown> implements IPool<Worker, Data, Response> {
     readonly numberOfWorkers: number;
@@ -174,6 +174,7 @@ export declare abstract class AbstractPool<Worker extends IWorker, Data = unknow
      * Gets the given worker its tasks usage in the pool.
      *
      * @param worker - The worker.
+     * @throws {@link Error} if the worker is not found in the pool worker nodes.
      * @returns The worker tasks usage.
      */
     private getWorkerTasksUsage;

package/lib/pools/cluster/dynamic.d.ts

@@ -8,7 +8,7 @@ import { FixedClusterPool } from './fixed';
  * 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 serializable data.
- * @typeParam Response - Type of response of execution. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
  * @author [Christopher Quadflieg](https://github.com/Shinigami92)
  * @since 2.0.0
  */

package/lib/pools/cluster/fixed.d.ts

@@ -29,7 +29,7 @@ export interface ClusterPoolOptions extends PoolOptions<Worker> {
  * This pool selects the workers in a round robin fashion.
  *
  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of response of execution. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
  * @author [Christopher Quadflieg](https://github.com/Shinigami92)
  * @since 2.0.0
  */

package/lib/pools/pool.d.ts

@@ -6,6 +6,7 @@ import type { WorkerChoiceStrategy, WorkerChoiceStrategyOptions } from './select
  * Pool types.
  *
  * @enum
+ * @internal
  */
 export declare enum PoolType {
     /**
@@ -47,7 +48,7 @@ export interface TasksQueueOptions {
 /**
  * Options for a poolifier pool.
  *
- * @typeParam Worker - The worker type.
+ * @typeParam Worker - Type of worker.
  */
 export interface PoolOptions<Worker extends IWorker> {
     /**
@@ -99,7 +100,7 @@ export interface PoolOptions<Worker extends IWorker> {
  *
  * @typeParam Worker - Type of worker which manages this pool.
  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of response of execution. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
  */
 export interface IPool<Worker extends IWorker, Data = unknown, Response = unknown> {
     /**

package/lib/pools/selection-strategies/abstract-worker-choice-strategy.d.ts

@@ -6,7 +6,7 @@ import type { IWorkerChoiceStrategy, RequiredStatistics, WorkerChoiceStrategyOpt
  *
  * @typeParam Worker - Type of worker which manages the strategy.
  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of response of execution. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
  */
 export declare abstract class AbstractWorkerChoiceStrategy<Worker extends IWorker, Data = unknown, Response = unknown> implements IWorkerChoiceStrategy {
     protected readonly pool: IPool<Worker, Data, Response>;

package/lib/pools/selection-strategies/fair-share-worker-choice-strategy.d.ts

@@ -7,7 +7,7 @@ import type { IWorkerChoiceStrategy, RequiredStatistics } from './selection-stra
  *
  * @typeParam Worker - Type of worker which manages the strategy.
  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of response of execution. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
  */
 export declare class FairShareWorkerChoiceStrategy<Worker extends IWorker, Data = unknown, Response = unknown> extends AbstractWorkerChoiceStrategy<Worker, Data, Response> implements IWorkerChoiceStrategy {
     /** @inheritDoc */

package/lib/pools/selection-strategies/less-busy-worker-choice-strategy.d.ts

@@ -6,7 +6,7 @@ import type { IWorkerChoiceStrategy, RequiredStatistics } from './selection-stra
  *
  * @typeParam Worker - Type of worker which manages the strategy.
  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of response of execution. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
  */
 export declare class LessBusyWorkerChoiceStrategy<Worker extends IWorker, Data = unknown, Response = unknown> extends AbstractWorkerChoiceStrategy<Worker, Data, Response> implements IWorkerChoiceStrategy {
     /** @inheritDoc */

package/lib/pools/selection-strategies/less-used-worker-choice-strategy.d.ts

@@ -6,7 +6,7 @@ import type { IWorkerChoiceStrategy } from './selection-strategies-types';
  *
  * @typeParam Worker - Type of worker which manages the strategy.
  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of response of execution. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
  */
 export declare class LessUsedWorkerChoiceStrategy<Worker extends IWorker, Data = unknown, Response = unknown> extends AbstractWorkerChoiceStrategy<Worker, Data, Response> implements IWorkerChoiceStrategy {
     /** @inheritDoc */

package/lib/pools/selection-strategies/round-robin-worker-choice-strategy.d.ts

@@ -6,7 +6,7 @@ import type { IWorkerChoiceStrategy } from './selection-strategies-types';
  *
  * @typeParam Worker - Type of worker which manages the strategy.
  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of response of execution. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
  */
 export declare class RoundRobinWorkerChoiceStrategy<Worker extends IWorker, Data = unknown, Response = unknown> extends AbstractWorkerChoiceStrategy<Worker, Data, Response> implements IWorkerChoiceStrategy {
     /**

package/lib/pools/selection-strategies/selection-strategies-types.d.ts

@@ -38,6 +38,8 @@ export interface WorkerChoiceStrategyOptions {
 }
 /**
  * Pool worker tasks usage statistics requirements.
+ *
+ * @internal
  */
 export interface RequiredStatistics {
     /**

package/lib/pools/selection-strategies/weighted-round-robin-worker-choice-strategy.d.ts

@@ -8,7 +8,7 @@ import type { IPool } from '../pool';
  *
  * @typeParam Worker - Type of worker which manages the strategy.
  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of response of execution. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
  */
 export declare class WeightedRoundRobinWorkerChoiceStrategy<Worker extends IWorker, Data = unknown, Response = unknown> extends AbstractWorkerChoiceStrategy<Worker, Data, Response> implements IWorkerChoiceStrategy {
     /** @inheritDoc */

package/lib/pools/selection-strategies/worker-choice-strategy-context.d.ts

@@ -6,7 +6,7 @@ import type { RequiredStatistics, WorkerChoiceStrategy, WorkerChoiceStrategyOpti
  *
  * @typeParam Worker - Type of worker.
  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of response of execution. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
  */
 export declare class WorkerChoiceStrategyContext<Worker extends IWorker, Data = unknown, Response = unknown> {
     private workerChoiceStrategyType;

package/lib/pools/thread/dynamic.d.ts

@@ -9,7 +9,7 @@ import { FixedThreadPool } from './fixed';
  * 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 serializable data.
- * @typeParam Response - Type of response of execution. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
  * @author [Alessandro Pio Ardizio](https://github.com/pioardi)
  * @since 0.0.1
  */

package/lib/pools/thread/fixed.d.ts

@@ -16,7 +16,7 @@ export type ThreadWorkerWithMessageChannel = Worker & Draft<MessageChannel>;
  * This pool selects the threads in a round robin fashion.
  *
  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of response of execution. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
  * @author [Alessandro Pio Ardizio](https://github.com/pioardi)
  * @since 0.0.1
  */

package/lib/pools/worker.d.ts

@@ -16,31 +16,54 @@ export type OnlineHandler<Worker extends IWorker> = (this: Worker) => void;
  */
 export type ExitHandler<Worker extends IWorker> = (this: Worker, code: number) => void;
 /**
- * Worker task interface.
+ * 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 serializable data.
  * @internal
  */
 export interface Task<Data = unknown> {
     /**
-     * Worker task data.
+     * Input data that will be passed to the worker.
      */
-    data: Data;
+    readonly data?: Data;
     /**
-     * Task UUID.
+     * UUID of the message.
      */
-    id: string;
+    readonly id?: string;
 }
 /**
  * Worker tasks usage statistics.
+ *
+ * @internal
  */
 export interface TasksUsage {
+    /**
+     * Number of tasks executed.
+     */
     run: number;
+    /**
+     * Number of tasks running.
+     */
     running: number;
+    /**
+     * Tasks runtime.
+     */
     runTime: number;
+    /**
+     * Tasks runtime history.
+     */
     runTimeHistory: CircularArray<number>;
+    /**
+     * Average tasks runtime.
+     */
     avgRunTime: number;
+    /**
+     * Median tasks runtime.
+     */
     medRunTime: number;
+    /**
+     * Number of tasks errored.
+     */
     error: number;
 }
 /**
@@ -73,7 +96,7 @@ export interface WorkerNode<Worker extends IWorker, Data = unknown> {
     /**
      * Worker node worker.
      */
-    worker: Worker;
+    readonly worker: Worker;
     /**
      * Worker node tasks usage statistics.
      */
@@ -81,5 +104,5 @@ export interface WorkerNode<Worker extends IWorker, Data = unknown> {
     /**
      * Worker node tasks queue.
      */
-    tasksQueue: Array<Task<Data>>;
+    readonly tasksQueue: Array<Task<Data>>;
 }

package/lib/utility-types.d.ts

@@ -3,7 +3,7 @@
 import type { Worker as ClusterWorker } from 'node:cluster';
 import type { MessagePort } from 'node:worker_threads';
 import type { KillBehavior } from './worker/worker-options';
-import type { IWorker } from './pools/worker';
+import type { IWorker, Task } from './pools/worker';
 /**
  * Make all properties in T non-readonly.
  */
@@ -11,20 +11,13 @@ export type Draft<T> = {
     -readonly [P in keyof T]?: T[P];
 };
 /**
- * Message object that is passed between worker and main worker.
+ * Message object that is passed between main worker and worker.
  *
  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
  * @typeParam MainWorker - Type of main worker.
+ * @internal
  */
-export interface MessageValue<Data = unknown, MainWorker extends ClusterWorker | MessagePort | unknown = unknown> {
-    /**
-     * Input data that will be passed to the worker.
-     */
-    readonly data?: Data;
-    /**
-     * Id of the message.
-     */
-    readonly id?: string;
+export interface MessageValue<Data = unknown, MainWorker extends ClusterWorker | MessagePort | unknown = unknown> extends Task<Data> {
     /**
      * Kill code.
      */

package/lib/worker/worker-options.d.ts

@@ -18,7 +18,7 @@ export type KillBehavior = keyof typeof KillBehaviors;
 /**
  * Detects whether the given value is a kill behavior or not.
  *
- * @typeParam KB - Which specific KillBehavior to test against.
+ * @typeParam KB - Which specific KillBehavior type to test against.
  * @param killBehavior - Which kind of kill behavior to detect.
  * @param value - Any value.
  * @returns `true` if `value` was strictly equals to `killBehavior`, otherwise `false`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "poolifier",
-  "version": "2.4.7",
+  "version": "2.4.8",
   "description": "A fast, easy to use Node.js Worker Thread Pool and Cluster Pool implementation",
   "license": "MIT",
   "main": "./lib/index.js",