X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=82aed5526c976a1d05691dd04d922d4f33bcd5ee;hb=b46d5ebcbac30dbc70aa7c47433fd20204f1b01e;hp=3bb0ac9d66ef550f254b8535d3fd23d4f369a4f6;hpb=aec509b85e7d73e9883c8885e27fc4e34fdaef1e;p=poolifier.git

diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index 3bb0ac9d..82aed552 100644
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -30,32 +30,55 @@ export type ExitHandler<Worker extends IWorker> = (
 ) => 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
 }
 
@@ -93,7 +116,7 @@ export interface WorkerNode<Worker extends IWorker, Data = unknown> {
   /**
    * Worker node worker.
    */
-  worker: Worker
+  readonly worker: Worker
   /**
    * Worker node tasks usage statistics.
    */
@@ -101,5 +124,5 @@ export interface WorkerNode<Worker extends IWorker, Data = unknown> {
   /**
    * Worker node tasks queue.
    */
-  tasksQueue: Array<Task<Data>>
+  readonly tasksQueue: Array<Task<Data>>
 }