Merge branch 'master' of github.com:poolifier/poolifier

[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 0e1cf64188ff7e4d1b2e026f9373bb7a57b9bf42..065b310fa5e8a3454f84d5b0edd6324c7c2d0520 100644 (file)
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -33,15 +33,29 @@ export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
  * Worker choice strategy options.
  */
 export interface WorkerChoiceStrategyOptions {
+  /**
+   * Use tasks median run time instead of average run time.
+   */
   medRunTime?: boolean
 }
 
 /**
  * Pool worker tasks usage statistics requirements.
+ *
+ * @internal
  */
 export interface RequiredStatistics {
+  /**
+   * Require tasks run time.
+   */
   runTime: boolean
+  /**
+   * Require tasks average run time.
+   */
   avgRunTime: boolean
+  /**
+   * Require tasks median run time.
+   */
   medRunTime: boolean
 }