build(deps-dev): apply updates
[poolifier.git] / src / utility-types.ts
index 0723b4395407a94b18d3cafcfc6e5db2360017e0..12067c077e06599339a0b01e0ebc51df42178713 100644 (file)
@@ -1,6 +1,6 @@
 import type { EventLoopUtilization } from 'node:perf_hooks'
+import type { MessagePort, TransferListItem } from 'node:worker_threads'
 import type { KillBehavior } from './worker/worker-options'
-import type { IWorker } from './pools/worker'
 
 /**
  * Task error.
@@ -75,14 +75,18 @@ export interface Task<Data = unknown> {
    * Task input data that will be passed to the worker.
    */
   readonly data?: Data
+  /**
+   * Array of transferable objects.
+   */
+  readonly transferList?: TransferListItem[]
   /**
    * Timestamp.
    */
   readonly timestamp?: number
   /**
-   * Message UUID.
+   * Task UUID.
    */
-  readonly id?: string
+  readonly taskId?: string
 }
 
 /**
@@ -97,7 +101,7 @@ export interface MessageValue<Data = unknown, ErrorData = unknown>
   /**
    * Kill code.
    */
-  readonly kill?: KillBehavior | true
+  readonly kill?: KillBehavior | true | 'success' | 'failure'
   /**
    * Task error.
    */
@@ -106,6 +110,10 @@ export interface MessageValue<Data = unknown, ErrorData = unknown>
    * Task performance.
    */
   readonly taskPerformance?: TaskPerformance
+  /**
+   * Task function names.
+   */
+  readonly taskFunctions?: string[]
   /**
    * Whether the worker computes the given statistics or not.
    */
@@ -118,19 +126,19 @@ export interface MessageValue<Data = unknown, ErrorData = unknown>
    * Whether the worker starts or stops its activity check.
    */
   readonly checkActive?: boolean
+  /**
+   * Message port.
+   */
+  readonly port?: MessagePort
 }
 
 /**
- * An object holding the execution response promise resolve/reject callbacks.
+ * An object holding the task execution response promise resolve/reject callbacks.
  *
- * @typeParam Worker - Type of worker.
  * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
  * @internal
  */
-export interface PromiseResponseWrapper<
-  Worker extends IWorker,
-  Response = unknown
-> {
+export interface PromiseResponseWrapper<Response = unknown> {
   /**
    * Resolve callback to fulfill the promise.
    */
@@ -140,7 +148,9 @@ export interface PromiseResponseWrapper<
    */
   readonly reject: (reason?: unknown) => void
   /**
-   * The worker handling the execution.
+   * The worker node key executing the task.
    */
-  readonly worker: Worker
+  readonly workerNodeKey: number
 }
+
+export type Writable<T> = { -readonly [P in keyof T]: T[P] }