build(ci): use PAT for continuous benchmark results
[poolifier.git] / src / pools / worker.ts
index be134f05f539b87bf254bbfb71e68c90e360946c..29050455088c6efd49d8147aed07c41f2a5a004e 100644 (file)
@@ -132,7 +132,7 @@ export interface WorkerInfo {
   /**
    * Worker type.
    */
-  type: WorkerType
+  readonly type: WorkerType
   /**
    * Dynamic flag.
    */
@@ -171,6 +171,15 @@ export interface WorkerUsage {
   readonly elu: EventLoopUtilizationMeasurementStatistics
 }
 
+/**
+ * Worker choice strategy data.
+ *
+ * @internal
+ */
+export interface StrategyData {
+  virtualTaskEndTimestamp?: number
+}
+
 /**
  * Worker interface.
  */
@@ -199,6 +208,12 @@ export interface IWorker {
   readonly once: (event: 'exit', handler: ExitHandler<this>) => void
 }
 
+/**
+ * Worker node event callback.
+ *
+ * @param workerId - The worker id.
+ * @internal
+ */
 export type WorkerNodeEventCallback = (workerId: number) => void
 
 /**
@@ -220,7 +235,12 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown> {
   /**
    * Worker usage statistics.
    */
-  usage: WorkerUsage
+  readonly usage: WorkerUsage
+  /**
+   * Worker choice strategy data.
+   * This is used to store data that is specific to the worker choice strategy.
+   */
+  strategyData?: StrategyData
   /**
    * Message channel (worker_threads only).
    */
@@ -232,14 +252,10 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown> {
   tasksQueueBackPressureSize: number
   /**
    * Callback invoked when worker node tasks queue is back pressured.
-   *
-   * @param workerId - The worker id.
    */
   onBackPressure?: WorkerNodeEventCallback
   /**
    * Callback invoked when worker node tasks queue is empty.
-   *
-   * @param workerId - The worker id.
    */
   onEmptyQueue?: WorkerNodeEventCallback
   /**