refactor: rename worker `started` flag to `ready`

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

diff --git a/src/utility-types.ts b/src/utility-types.ts
index bca2de2b91eec91a2c1113e5b422f5cc03301cba..f1b773eb31196c5ca827759bbbf3f70a37fc1ae9 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -11,37 +11,41 @@ export interface TaskError<Data = unknown> {
   /**
    * Worker id.
    */
-  workerId: number
+  readonly workerId: number
   /**
    * Error message.
    */
-  message: string
+  readonly message: string
   /**
    * Data passed to the worker triggering the error.
    */
-  data?: Data
+  readonly data?: Data
 }
 
 /**
  * Task performance.
+ *
+ * @internal
  */
 export interface TaskPerformance {
   /**
    * 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
@@ -64,7 +68,7 @@ export interface MessageValue<Data = unknown, ErrorData = unknown>
   /**
    * Kill code.
    */
-  readonly kill?: KillBehavior | 1
+  readonly kill?: KillBehavior | true
   /**
    * Task error.
    */
@@ -78,9 +82,13 @@ export interface MessageValue<Data = unknown, ErrorData = unknown>
    */
   readonly statistics?: WorkerStatistics
   /**
-   * Whether the worker has started or not.
+   * Whether the worker is ready or not.
+   */
+  readonly ready?: boolean
+  /**
+   * Whether the worker starts or stops its aliveness check.
    */
-  readonly started?: boolean
+  readonly checkAlive?: boolean
 }
 
 /**