X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Futility-types.ts;h=f13cce6a70d9f60ed7417b9d2a45675c5179fb72;hb=HEAD;hp=82f79230accb88160ae612e9d5cc5ba7da57d157;hpb=5d9133ae9ef83c5f69e26daf8dcfea584884d9c4;p=poolifier.git

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 82f79230..8ccb1a74 100644
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -7,62 +7,59 @@ import type { KillBehavior } from './worker/worker-options.js'
 
 /**
  * Worker error.
- *
  * @typeParam Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
  */
 export interface WorkerError<Data = unknown> {
   /**
-   * Task function name triggering the error.
+   * Data triggering the error.
    */
-  readonly name: string
+  readonly data?: Data
   /**
    * Error message.
    */
   readonly message: string
   /**
-   * Data triggering the error.
+   * Task function name triggering the error.
    */
-  readonly data?: Data
+  readonly name: string
 }
 
 /**
  * Task performance.
- *
  * @internal
  */
 export interface TaskPerformance {
   /**
-   * Task name.
+   * Task event loop utilization.
    */
-  readonly name: string
+  readonly elu?: EventLoopUtilization
   /**
-   * Task performance timestamp.
+   * Task name.
    */
-  readonly timestamp: number
+  readonly name: string
   /**
    * Task runtime.
    */
   readonly runTime?: number
   /**
-   * Task event loop utilization.
+   * Task performance timestamp.
    */
-  readonly elu?: EventLoopUtilization
+  readonly timestamp: number
 }
 
 /**
  * Worker task performance statistics computation settings.
- *
  * @internal
  */
 export interface WorkerStatistics {
-  /**
-   * Whether the worker computes the task runtime or not.
-   */
-  readonly runTime: boolean
   /**
    * Whether the worker computes the task event loop utilization (ELU) or not.
    */
   readonly elu: boolean
+  /**
+   * Whether the worker computes the task runtime or not.
+   */
+  readonly runTime: boolean
 }
 
 /**
@@ -85,22 +82,20 @@ export interface TaskFunctionProperties {
 
 /**
  * Message object that is passed as a task between main worker and worker.
- *
  * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
  * @internal
  */
 export interface Task<Data = unknown> {
-  /**
-   * Task name.
-   */
-  readonly name?: string
   /**
    * Task input data that will be passed to the worker.
    */
   readonly data?: Data
+  /**
+   * Task name.
+   */
+  readonly name?: string
   /**
    * Task priority. Lower values have higher priority.
-   *
    * @defaultValue 0
    */
   readonly priority?: number
@@ -109,22 +104,21 @@ export interface Task<Data = unknown> {
    */
   readonly strategy?: WorkerChoiceStrategy
   /**
-   * Array of transferable objects.
+   * Task UUID.
    */
-  readonly transferList?: readonly TransferListItem[]
+  readonly taskId?: `${string}-${string}-${string}-${string}-${string}`
   /**
    * Timestamp.
    */
   readonly timestamp?: number
   /**
-   * Task UUID.
+   * Array of transferable objects.
    */
-  readonly taskId?: `${string}-${string}-${string}-${string}-${string}`
+  readonly transferList?: readonly TransferListItem[]
 }
 
 /**
  * Message object that is passed between main worker and 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
@@ -132,28 +126,36 @@ export interface Task<Data = unknown> {
 export interface MessageValue<Data = unknown, ErrorData = unknown>
   extends Task<Data> {
   /**
-   * Worker id.
+   * Whether the worker starts or stops its activity check.
    */
-  readonly workerId?: number
+  readonly checkActive?: boolean
   /**
    * Kill code.
    */
-  readonly kill?: KillBehavior | true | 'success' | 'failure'
+  readonly kill?: 'failure' | 'success' | KillBehavior | true
   /**
-   * Worker error.
+   * Message port.
    */
-  readonly workerError?: WorkerError<ErrorData>
+  readonly port?: MessagePort
   /**
-   * Task performance.
+   * Whether the worker is ready or not.
    */
-  readonly taskPerformance?: TaskPerformance
+  readonly ready?: boolean
+  /**
+   * Whether the worker computes the given statistics or not.
+   */
+  readonly statistics?: WorkerStatistics
+  /**
+   * Task function serialized to string.
+   */
+  readonly taskFunction?: string
   /**
    * Task function operation:
    * - `'add'` - Add a task function.
    * - `'remove'` - Remove a task function.
    * - `'default'` - Set a task function as default.
    */
-  readonly taskFunctionOperation?: 'add' | 'remove' | 'default'
+  readonly taskFunctionOperation?: 'add' | 'default' | 'remove'
   /**
    * Whether the task function operation is successful or not.
    */
@@ -162,55 +164,51 @@ export interface MessageValue<Data = unknown, ErrorData = unknown>
    * Task function properties.
    */
   readonly taskFunctionProperties?: TaskFunctionProperties
-  /**
-   * Task function serialized to string.
-   */
-  readonly taskFunction?: string
   /**
    * Task functions properties.
    */
   readonly taskFunctionsProperties?: TaskFunctionProperties[]
   /**
-   * Whether the worker computes the given statistics or not.
-   */
-  readonly statistics?: WorkerStatistics
-  /**
-   * Whether the worker is ready or not.
+   * Task performance.
    */
-  readonly ready?: boolean
+  readonly taskPerformance?: TaskPerformance
   /**
-   * Whether the worker starts or stops its activity check.
+   * Worker error.
    */
-  readonly checkActive?: boolean
+  readonly workerError?: WorkerError<ErrorData>
   /**
-   * Message port.
+   * Worker id.
    */
-  readonly port?: MessagePort
+  readonly workerId?: number
 }
 
 /**
  * An object holding the task execution response promise resolve/reject callbacks.
- *
  * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
  * @internal
  */
 export interface PromiseResponseWrapper<Response = unknown> {
   /**
-   * Resolve callback to fulfill the promise.
+   * The asynchronous resource used to track the task execution.
    */
-  readonly resolve: (value: Response | PromiseLike<Response>) => void
+  readonly asyncResource?: AsyncResource
   /**
    * Reject callback to reject the promise.
    */
   readonly reject: (reason?: unknown) => void
   /**
-   * The worker node key executing the task.
+   * Resolve callback to fulfill the promise.
    */
-  readonly workerNodeKey: number
+  readonly resolve: (value: PromiseLike<Response> | Response) => void
   /**
-   * The asynchronous resource used to track the task execution.
+   * The worker node key executing the task.
    */
-  readonly asyncResource?: AsyncResource
+  readonly workerNodeKey: number
 }
 
+/**
+ * Remove readonly modifier from all properties of T.
+ * @typeParam T - Type to remove readonly modifier.
+ * @internal
+ */
 export type Writable<T> = { -readonly [P in keyof T]: T[P] }