refactor: incrementation consistency

[poolifier.git] / src / utility-types.ts

diff --git a/src/utility-types.ts b/src/utility-types.ts
index da2fa22300c58c99998a637c31f531dba8c982c0..28bf19e256abaef2f619051773ad55456643b842 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,6 +1,6 @@
 import type { EventLoopUtilization } from 'node:perf_hooks'
 import type { KillBehavior } from './worker/worker-options'
-import type { IWorker, Task } from './pools/worker'
+import type { IWorker } from './pools/worker'
 
 /**
  * Task error.
@@ -8,59 +8,96 @@ import type { IWorker, Task } from './pools/worker'
  * @typeParam Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
  */
 export interface TaskError<Data = unknown> {
+  /**
+   * Task name triggering the error.
+   */
+  readonly name: string
   /**
    * Error message.
    */
-  message: string
+  readonly message: string
   /**
-   * Data passed to the worker triggering the error.
+   * Data triggering the error.
    */
-  data?: Data
+  readonly data?: Data
 }
 
 /**
  * Task performance.
+ *
+ * @internal
  */
 export interface TaskPerformance {
+  /**
+   * Task name.
+   */
+  readonly name: string
   /**
    * Task performance timestamp.
    */
-  timestamp: number
+  readonly timestamp: number
   /**
    * Task runtime.
    */
-  runTime?: number
+  readonly runTime?: number
   /**
    * Task event loop utilization.
    */
-  elu?: EventLoopUtilization
+  readonly elu?: EventLoopUtilization
 }
 
 /**
  * Performance statistics computation.
+ *
+ * @internal
  */
 export interface WorkerStatistics {
   runTime: boolean
   elu: boolean
 }
 
+/**
+ * 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.
+ * @internal
+ */
+export interface Task<Data = unknown> {
+  /**
+   * Worker id.
+   */
+  readonly workerId: number
+  /**
+   * Task name.
+   */
+  readonly name?: string
+  /**
+   * Task input data that will be passed to the worker.
+   */
+  readonly data?: Data
+  /**
+   * Timestamp.
+   */
+  readonly timestamp?: number
+  /**
+   * Message UUID.
+   */
+  readonly id?: string
+}
+
 /**
  * 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.
- * @typeParam MainWorker - Type of main worker.
  * @internal
  */
-export interface MessageValue<
-  Data = unknown,
-  ErrorData = unknown,
-  MainWorker = NodeJS.Process | MessagePort
-> extends Task<Data> {
+export interface MessageValue<Data = unknown, ErrorData = unknown>
+  extends Task<Data> {
   /**
    * Kill code.
    */
-  readonly kill?: KillBehavior | 1
+  readonly kill?: KillBehavior | true
   /**
    * Task error.
    */
@@ -70,13 +107,17 @@ export interface MessageValue<
    */
   readonly taskPerformance?: TaskPerformance
   /**
-   * Reference to main worker.
+   * Whether the worker computes the given statistics or not.
    */
-  readonly parent?: MainWorker
+  readonly statistics?: WorkerStatistics
   /**
-   * Whether to compute the given statistics or not.
+   * Whether the worker is ready or not.
    */
-  readonly statistics?: WorkerStatistics
+  readonly ready?: boolean
+  /**
+   * Whether the worker starts or stops its aliveness check.
+   */
+  readonly checkAlive?: boolean
 }
 
 /**