docs: refine documentation

[poolifier.git] / src / pools / selection-strategies / selection-strategies-types.ts

diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
index 23efd2993d64eefd07087032e8ae39be5c2f0ccd..137c1be7562e50309818763f556651aed2034b04 100644 (file)
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -1,3 +1,4 @@
+import type { IPoolInternal } from '../pool-internal'
 import type { IPoolWorker } from '../pool-worker'
 
 /**
@@ -12,6 +13,10 @@ export const WorkerChoiceStrategies = Object.freeze({
    * Less used worker selection strategy.
    */
   LESS_USED: 'LESS_USED',
+  /**
+   * Less busy worker selection strategy.
+   */
+  LESS_BUSY: 'LESS_BUSY',
   /**
    * Fair share worker selection strategy.
    */
@@ -28,20 +33,27 @@ export const WorkerChoiceStrategies = Object.freeze({
 export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
 
 /**
- * Pool tasks usage statistics requirements.
+ * Pool worker tasks usage statistics requirements.
  */
 export interface RequiredStatistics {
   runTime: boolean
+  avgRunTime: boolean
 }
 
 /**
  * Worker choice strategy interface.
- *
- * @typeParam Worker - Type of worker which manages the strategy.
  */
-export interface IWorkerChoiceStrategy<Worker extends IPoolWorker> {
+export interface IWorkerChoiceStrategy<
+  Worker extends IPoolWorker,
+  Data = unknown,
+  Response = unknown
+> {
+  /**
+   * The pool instance.
+   */
+  readonly pool: IPoolInternal<Worker, Data, Response>
   /**
-   * Is the pool attached to the strategy dynamic?.
+   * Is the pool bound to the strategy dynamic?.
    */
   readonly isDynamicPool: boolean
   /**
@@ -53,7 +65,13 @@ export interface IWorkerChoiceStrategy<Worker extends IPoolWorker> {
    */
   reset: () => boolean
   /**
-   * Chooses a worker in the pool.
+   * Chooses a worker in the pool and returns its key.
+   */
+  choose: () => number
+  /**
+   * Removes a worker reference from strategy internals.
+   *
+   * @param workerKey - The worker key.
    */
-  choose: () => Worker
+  remove: (workerKey: number) => boolean
 }