docs: refinements

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

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 3917ad2042b920f7509749605d86f073208c71cb..1eb8df50ed527bf80eeff0eebee1721fe7e7f0c4 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,16 +1,12 @@
-import type { Worker as ClusterWorker } from 'node:cluster'
-import type { MessagePort } from 'node:worker_threads'
 import type { EventLoopUtilization } from 'node:perf_hooks'
 import type { KillBehavior } from './worker/worker-options'
 import type { IWorker, Task } from './pools/worker'
 
 /**
- * Make all properties in T non-readonly.
+ * Task error.
  *
- * @typeParam T - Type in which properties will be non-readonly.
+ * @typeParam Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
  */
-export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
-
 export interface TaskError<Data = unknown> {
   /**
    * Error message.
@@ -34,10 +30,6 @@ export interface TaskPerformance {
    * Task runtime.
    */
   runTime?: number
-  /**
-   * Task wait time.
-   */
-  waitTime?: number
   /**
    * Task event loop utilization.
    */
@@ -49,22 +41,18 @@ export interface TaskPerformance {
  */
 export interface WorkerStatistics {
   runTime: boolean
-  waitTime: boolean
   elu: boolean
 }
 
 /**
  * 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.
+ * @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.
  * @internal
  */
-export interface MessageValue<
-  Data = unknown,
-  ErrorData = unknown,
-  MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort
-> extends Task<Data> {
+export interface MessageValue<Data = unknown, ErrorData = unknown>
+  extends Task<Data> {
   /**
    * Kill code.
    */
@@ -78,11 +66,7 @@ export interface MessageValue<
    */
   readonly taskPerformance?: TaskPerformance
   /**
-   * Reference to main worker.
-   */
-  readonly parent?: MainWorker
-  /**
-   * Whether to compute the given statistics or not.
+   * Whether the worker computes the given statistics or not.
    */
   readonly statistics?: WorkerStatistics
 }
@@ -91,7 +75,7 @@ export interface MessageValue<
  * An object holding the execution response promise resolve/reject callbacks.
  *
  * @typeParam Worker - Type of worker.
- * @typeParam Response - Type of execution response. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
  * @internal
  */
 export interface PromiseResponseWrapper<