src/utility-types.ts

   1 import type { Worker as ClusterWorker } from 'node:cluster'
   2 import type { MessagePort } from 'node:worker_threads'
   3 import type { KillBehavior } from './worker/worker-options'
   4 import type { IWorker, Task } from './pools/worker'
   5
   6 /**
   7  * Make all properties in T non-readonly.
   8  *
   9  * @typeParam T - Type in which properties will be non-readonly.
  10  */
  11 export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
  12
  13 /**
  14  * Message object that is passed between main worker and worker.
  15  *
  16  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
  17  * @typeParam MainWorker - Type of main worker.
  18  * @internal
  19  */
  20 export interface MessageValue<
  21   Data = unknown,
  22   MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort
  23 > extends Task<Data> {
  24   /**
  25    * Kill code.
  26    */
  27   readonly kill?: KillBehavior | 1
  28   /**
  29    * Task error.
  30    */
  31   readonly error?: string
  32   /**
  33    * Task data triggering task error.
  34    */
  35   readonly errorData?: unknown
  36   /**
  37    * Runtime.
  38    */
  39   readonly runTime?: number
  40   /**
  41    * Wait time.
  42    */
  43   readonly waitTime?: number
  44   /**
  45    * Reference to main worker.
  46    */
  47   readonly parent?: MainWorker
  48 }
  49
  50 /**
  51  * Worker synchronous function that can be executed.
  52  *
  53  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
  54  * @typeParam Response - Type of execution response. This can only be serializable data.
  55  */
  56 export type WorkerSyncFunction<Data = unknown, Response = unknown> = (
  57   data?: Data
  58 ) => Response
  59
  60 /**
  61  * Worker asynchronous function that can be executed.
  62  * This function must return a promise.
  63  *
  64  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
  65  * @typeParam Response - Type of execution response. This can only be serializable data.
  66  */
  67 export type WorkerAsyncFunction<Data = unknown, Response = unknown> = (
  68   data?: Data
  69 ) => Promise<Response>
  70
  71 /**
  72  * Worker function that can be executed.
  73  * This function can be synchronous or asynchronous.
  74  *
  75  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
  76  * @typeParam Response - Type of execution response. This can only be serializable data.
  77  */
  78 export type WorkerFunction<Data = unknown, Response = unknown> =
  79   | WorkerSyncFunction<Data, Response>
  80   | WorkerAsyncFunction<Data, Response>
  81
  82 /**
  83  * Worker functions that can be executed.
  84  * This object can contain synchronous or asynchronous functions.
  85  * The key is the name of the function.
  86  * The value is the function itself.
  87  *
  88  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
  89  * @typeParam Response - Type of execution response. This can only be serializable data.
  90  */
  91 export type TaskFunctions<Data = unknown, Response = unknown> = Record<
  92 string,
  93 WorkerFunction<Data, Response>
  94 >
  95
  96 /**
  97  * An object holding the execution response promise resolve/reject callbacks.
  98  *
  99  * @typeParam Worker - Type of worker.
 100  * @typeParam Response - Type of execution response. This can only be serializable data.
 101  * @internal
 102  */
 103 export interface PromiseResponseWrapper<
 104   Worker extends IWorker,
 105   Response = unknown
 106 > {
 107   /**
 108    * Resolve callback to fulfill the promise.
 109    */
 110   readonly resolve: (value: Response) => void
 111   /**
 112    * Reject callback to reject the promise.
 113    */
 114   readonly reject: (reason?: string) => void
 115   /**
 116    * The worker handling the execution.
 117    */
 118   readonly worker: Worker
 119 }