X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=ddfe915d2e3c215f9365693c81754155c2c10bc5;hb=9e775f96c71628a400c029d69d28150defe4186c;hp=0e549cec338b685d36e80ab1ff3d147ef6a3f83f;hpb=08f3f44cef6256fdbab1a2a56842b291fd6dcd42;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index 0e549cec..ddfe915d 100644 --- a/src/pools/selection-strategies/selection-strategies-types.ts +++ b/src/pools/selection-strategies/selection-strategies-types.ts @@ -34,7 +34,7 @@ export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies */ export interface WorkerChoiceStrategyOptions { /** - * Use tasks median run time instead of average run time. + * Use tasks median runtime instead of average runtime. * * @defaultValue false */ @@ -55,15 +55,15 @@ export interface WorkerChoiceStrategyOptions { */ export interface RequiredStatistics { /** - * Require tasks run time. + * Require tasks runtime. */ runTime: boolean /** - * Require tasks average run time. + * Require tasks average runtime. */ avgRunTime: boolean /** - * Require tasks median run time. + * Require tasks median runtime. */ medRunTime: boolean } @@ -77,17 +77,28 @@ export interface IWorkerChoiceStrategy { */ readonly requiredStatistics: RequiredStatistics /** - * Resets strategy internals (counters, statistics, etc.). + * Resets strategy internals. + * + * @returns `true` if the reset is successful, `false` otherwise. */ reset: () => boolean + /** + * Updates the worker node key strategy internals. + * + * @returns `true` if the update is successful, `false` otherwise. + */ + update: (workerNodeKey: number) => boolean /** * Chooses a worker node in the pool and returns its key. + * + * @returns The worker node key. */ choose: () => number /** - * Removes a worker node key from strategy internals. + * Removes the worker node key from strategy internals. * * @param workerNodeKey - The worker node key. + * @returns `true` if the worker node key is removed, `false` otherwise. */ remove: (workerNodeKey: number) => boolean /**