src/utility-types.ts

   1 import type { EventLoopUtilization } from 'node:perf_hooks'
   2 import type { MessagePort, TransferListItem } from 'node:worker_threads'
   3 import type { KillBehavior } from './worker/worker-options'
   4
   5 /**
   6  * Task error.
   7  *
   8  * @typeParam Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
   9  */
  10 export interface TaskError<Data = unknown> {
  11   /**
  12    * Task name triggering the error.
  13    */
  14   readonly name: string
  15   /**
  16    * Error message.
  17    */
  18   readonly message: string
  19   /**
  20    * Data triggering the error.
  21    */
  22   readonly data?: Data
  23 }
  24
  25 /**
  26  * Task performance.
  27  *
  28  * @internal
  29  */
  30 export interface TaskPerformance {
  31   /**
  32    * Task name.
  33    */
  34   readonly name: string
  35   /**
  36    * Task performance timestamp.
  37    */
  38   readonly timestamp: number
  39   /**
  40    * Task runtime.
  41    */
  42   readonly runTime?: number
  43   /**
  44    * Task event loop utilization.
  45    */
  46   readonly elu?: EventLoopUtilization
  47 }
  48
  49 /**
  50  * Performance statistics computation.
  51  *
  52  * @internal
  53  */
  54 export interface WorkerStatistics {
  55   runTime: boolean
  56   elu: boolean
  57 }
  58
  59 /**
  60  * Message object that is passed as a task between main worker and worker.
  61  *
  62  * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
  63  * @internal
  64  */
  65 export interface Task<Data = unknown> {
  66   /**
  67    * Worker id.
  68    */
  69   readonly workerId: number
  70   /**
  71    * Task name.
  72    */
  73   readonly name?: string
  74   /**
  75    * Task input data that will be passed to the worker.
  76    */
  77   readonly data?: Data
  78   /**
  79    * Array of transferable objects.
  80    */
  81   readonly transferList?: TransferListItem[]
  82   /**
  83    * Timestamp.
  84    */
  85   readonly timestamp?: number
  86   /**
  87    * Task UUID.
  88    */
  89   readonly taskId?: string
  90 }
  91
  92 /**
  93  * Message object that is passed between main worker and worker.
  94  *
  95  * @typeParam Data - Type of data sent to the worker or execution response. This can only be structured-cloneable data.
  96  * @typeParam ErrorData - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
  97  * @internal
  98  */
  99 export interface MessageValue<Data = unknown, ErrorData = unknown>
 100   extends Task<Data> {
 101   /**
 102    * Kill code.
 103    */
 104   readonly kill?: KillBehavior | true
 105   /**
 106    * Task error.
 107    */
 108   readonly taskError?: TaskError<ErrorData>
 109   /**
 110    * Task performance.
 111    */
 112   readonly taskPerformance?: TaskPerformance
 113   /**
 114    * Whether the worker computes the given statistics or not.
 115    */
 116   readonly statistics?: WorkerStatistics
 117   /**
 118    * Whether the worker is ready or not.
 119    */
 120   readonly ready?: boolean
 121   /**
 122    * Whether the worker starts or stops its activity check.
 123    */
 124   readonly checkActive?: boolean
 125   /**
 126    * Message port.
 127    */
 128   readonly port?: MessagePort
 129 }
 130
 131 /**
 132  * An object holding the task execution response promise resolve/reject callbacks.
 133  *
 134  * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
 135  * @internal
 136  */
 137 export interface PromiseResponseWrapper<Response = unknown> {
 138   /**
 139    * Resolve callback to fulfill the promise.
 140    */
 141   readonly resolve: (value: Response | PromiseLike<Response>) => void
 142   /**
 143    * Reject callback to reject the promise.
 144    */
 145   readonly reject: (reason?: unknown) => void
 146   /**
 147    * The worker node key executing the task.
 148    */
 149   readonly workerNodeKey: number
 150 }