docs: refine circular buffer code comments

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

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 3817515a585120bb8e8c3c369dc57e1c59ac0c65..82f79230accb88160ae612e9d5cc5ba7da57d157 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,6 +1,9 @@
+import type { AsyncResource } from 'node:async_hooks'
 import type { EventLoopUtilization } from 'node:perf_hooks'
 import type { MessagePort, TransferListItem } from 'node:worker_threads'
-import type { KillBehavior } from './worker/worker-options'
+
+import type { WorkerChoiceStrategy } from './pools/selection-strategies/selection-strategies-types.js'
+import type { KillBehavior } from './worker/worker-options.js'
 
 /**
  * Worker error.
@@ -62,6 +65,24 @@ export interface WorkerStatistics {
   readonly elu: boolean
 }
 
+/**
+ * Task function properties.
+ */
+export interface TaskFunctionProperties {
+  /**
+   * Task function name.
+   */
+  readonly name: string
+  /**
+   * Task function priority. Lower values have higher priority.
+   */
+  readonly priority?: number
+  /**
+   * Task function worker choice strategy.
+   */
+  readonly strategy?: WorkerChoiceStrategy
+}
+
 /**
  * Message object that is passed as a task between main worker and worker.
  *
@@ -69,10 +90,6 @@ export interface WorkerStatistics {
  * @internal
  */
 export interface Task<Data = unknown> {
-  /**
-   * Worker id.
-   */
-  readonly workerId?: number
   /**
    * Task name.
    */
@@ -81,10 +98,20 @@ export interface Task<Data = unknown> {
    * Task input data that will be passed to the worker.
    */
   readonly data?: Data
+  /**
+   * Task priority. Lower values have higher priority.
+   *
+   * @defaultValue 0
+   */
+  readonly priority?: number
+  /**
+   * Task worker choice strategy.
+   */
+  readonly strategy?: WorkerChoiceStrategy
   /**
    * Array of transferable objects.
    */
-  readonly transferList?: TransferListItem[]
+  readonly transferList?: readonly TransferListItem[]
   /**
    * Timestamp.
    */
@@ -92,7 +119,7 @@ export interface Task<Data = unknown> {
   /**
    * Task UUID.
    */
-  readonly taskId?: string
+  readonly taskId?: `${string}-${string}-${string}-${string}-${string}`
 }
 
 /**
@@ -104,6 +131,10 @@ export interface Task<Data = unknown> {
  */
 export interface MessageValue<Data = unknown, ErrorData = unknown>
   extends Task<Data> {
+  /**
+   * Worker id.
+   */
+  readonly workerId?: number
   /**
    * Kill code.
    */
@@ -119,7 +150,7 @@ export interface MessageValue<Data = unknown, ErrorData = unknown>
   /**
    * Task function operation:
    * - `'add'` - Add a task function.
-   * - `'delete'` - Delete a task function.
+   * - `'remove'` - Remove a task function.
    * - `'default'` - Set a task function as default.
    */
   readonly taskFunctionOperation?: 'add' | 'remove' | 'default'
@@ -128,17 +159,17 @@ export interface MessageValue<Data = unknown, ErrorData = unknown>
    */
   readonly taskFunctionOperationStatus?: boolean
   /**
-   * Task function serialized to string.
+   * Task function properties.
    */
-  readonly taskFunction?: string
+  readonly taskFunctionProperties?: TaskFunctionProperties
   /**
-   * Task function name.
+   * Task function serialized to string.
    */
-  readonly taskFunctionName?: string
+  readonly taskFunction?: string
   /**
-   * Task function names.
+   * Task functions properties.
    */
-  readonly taskFunctionNames?: string[]
+  readonly taskFunctionsProperties?: TaskFunctionProperties[]
   /**
    * Whether the worker computes the given statistics or not.
    */
@@ -176,6 +207,10 @@ export interface PromiseResponseWrapper<Response = unknown> {
    * The worker node key executing the task.
    */
   readonly workerNodeKey: number
+  /**
+   * The asynchronous resource used to track the task execution.
+   */
+  readonly asyncResource?: AsyncResource
 }
 
 export type Writable<T> = { -readonly [P in keyof T]: T[P] }