X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=065b310fa5e8a3454f84d5b0edd6324c7c2d0520;hb=1d6ec394e8f7467f72baeb74dda4794fdc5ab322;hp=4fb2f3584aadffcc0f5224fdfb8ce6521a2979a8;hpb=3300e7bcb155358c2cc1eed6e4ac11581457616f;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index 4fb2f358..065b310f 100644 --- a/src/pools/selection-strategies/selection-strategies-types.ts +++ b/src/pools/selection-strategies/selection-strategies-types.ts @@ -1,6 +1,3 @@ -import type { IPoolInternal } from '../pool-internal' -import type { IPoolWorker } from '../pool-worker' - /** * Enumeration of worker choice strategies. */ @@ -32,35 +29,42 @@ 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 } /** * Worker choice strategy interface. */ -export interface IWorkerChoiceStrategy< - Worker extends IPoolWorker, - Data = unknown, - Response = unknown -> { - /** - * The pool instance. - * @readonly - */ - readonly pool: IPoolInternal - /** - * Is the pool attached to the strategy dynamic?. - * @readonly - */ - readonly isDynamicPool: boolean +export interface IWorkerChoiceStrategy { /** - * Required pool tasks usage statistics. - * @readonly + * Required tasks usage statistics. */ readonly requiredStatistics: RequiredStatistics /** @@ -68,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 }