X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=137c1be7562e50309818763f556651aed2034b04;hb=6533c3e6b6a95daade8d20577d6b816512e2aeeb;hp=9ae6676550be28564a12eae35f6e64ce15db640d;hpb=168c526f6e6913506e56f7d5107335c3d3d42938;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index 9ae66765..137c1be7 100644 --- 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' /** @@ -32,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 { +export interface IWorkerChoiceStrategy< + Worker extends IPoolWorker, + Data = unknown, + Response = unknown +> { /** - * Is the pool attached to the strategy dynamic?. + * The pool instance. + */ + readonly pool: IPoolInternal + /** + * Is the pool bound to the strategy dynamic?. */ readonly isDynamicPool: boolean /** @@ -57,7 +65,13 @@ export interface IWorkerChoiceStrategy { */ 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 }