chore: v2.6.14

[poolifier.git] / src / pools / worker.ts

diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index 81b49d3bc4a0f02fb99f964b626fecae387c2d33..58610eaaddacc2beea93809f80675bb8530010c0 100644 (file)
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -1,4 +1,5 @@
 import type { CircularArray } from '../circular-array'
+import type { Task } from '../utility-types'
 
 /**
  * Callback invoked if the worker has received a message.
@@ -29,31 +30,6 @@ export type ExitHandler<Worker extends IWorker> = (
   exitCode: number
 ) => void
 
-/**
- * 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
-  /**
-   * Timestamp.
-   */
-  readonly timestamp?: number
-  /**
-   * Message UUID.
-   */
-  readonly id?: string
-}
-
 /**
  * Measurement statistics.
  *
@@ -118,7 +94,7 @@ export interface TaskStatistics {
   /**
    * Maximum number of queued tasks.
    */
-  readonly maxQueued: number
+  readonly maxQueued?: number
   /**
    * Number of failed tasks.
    */
@@ -157,9 +133,9 @@ export interface WorkerInfo {
    */
   dynamic: boolean
   /**
-   * Started flag.
+   * Ready flag.
    */
-  started: boolean
+  ready: boolean
 }
 
 /**
@@ -223,42 +199,46 @@ export interface IWorker {
  */
 export interface IWorkerNode<Worker extends IWorker, Data = unknown> {
   /**
-   * Worker node worker.
+   * Worker.
    */
   readonly worker: Worker
   /**
-   * Worker node worker info.
+   * Worker info.
    */
   readonly info: WorkerInfo
   /**
-   * Worker node worker usage statistics.
+   * Worker usage statistics.
    */
   usage: WorkerUsage
   /**
-   * Worker node tasks queue size.
+   * Tasks queue size.
    *
    * @returns The tasks queue size.
    */
   readonly tasksQueueSize: () => number
   /**
-   * Worker node enqueue task.
+   * Enqueue task.
    *
    * @param task - The task to queue.
    * @returns The task queue size.
    */
   readonly enqueueTask: (task: Task<Data>) => number
   /**
-   * Worker node dequeue task.
+   * Dequeue task.
    *
    * @returns The dequeued task.
    */
   readonly dequeueTask: () => Task<Data> | undefined
   /**
-   * Worker node clear tasks queue.
+   * Clears tasks queue.
    */
   readonly clearTasksQueue: () => void
   /**
-   * Worker node reset usage statistics .
+   * Resets usage statistics .
    */
   readonly resetUsage: () => void
+  /**
+   * Gets task usage statistics.
+   */
+  readonly getTaskWorkerUsage: (name: string) => WorkerUsage | undefined
 }