X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=065b310fa5e8a3454f84d5b0edd6324c7c2d0520;hb=1d6ec394e8f7467f72baeb74dda4794fdc5ab322;hp=2207173448458a81be1d383f74a51d4b1b08964a;hpb=78099a150dc54d7adab495195fa5f133fd54e114;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index 22071734..065b310f 100644 --- a/src/pools/selection-strategies/selection-strategies-types.ts +++ b/src/pools/selection-strategies/selection-strategies-types.ts @@ -29,12 +29,33 @@ export const WorkerChoiceStrategies = Object.freeze({ */ 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 } @@ -43,7 +64,7 @@ export interface RequiredStatistics { */ export interface IWorkerChoiceStrategy { /** - * Required pool tasks usage statistics. + * Required tasks usage statistics. */ readonly requiredStatistics: RequiredStatistics /** @@ -51,13 +72,13 @@ export interface IWorkerChoiceStrategy { */ reset: () => boolean /** - * Chooses a worker in the pool and returns its key. + * Chooses a worker node in the pool and returns its key. */ choose: () => number /** - * Removes a worker reference from strategy internals. + * Removes a worker node key from strategy internals. * - * @param workerKey - The worker key. + * @param workerNodeKey - The worker node key. */ - remove: (workerKey: number) => boolean + remove: (workerNodeKey: number) => boolean }