docs: fix typedoc generation with inheritance
[poolifier.git] / src / pools / selection-strategies / less-used-worker-choice-strategy.ts
1 import type { IPoolWorker } from '../pool-worker'
2 import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy'
3 import type { IWorkerChoiceStrategy } from './selection-strategies-types'
4
5 /**
6 * Selects the less used worker.
7 *
8 * @typeParam Worker - Type of worker which manages the strategy.
9 * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
10 * @typeParam Response - Type of response of execution. This can only be serializable data.
11 */
12 export class LessUsedWorkerChoiceStrategy<
13 Worker extends IPoolWorker,
14 Data = unknown,
15 Response = unknown
16 >
17 extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
18 implements IWorkerChoiceStrategy<Worker, Data, Response> {
19 /** @inheritDoc */
20 public reset (): boolean {
21 return true
22 }
23
24 /** @inheritDoc */
25 public choose (): number {
26 const freeWorkerKey = this.pool.findFreeWorkerKey()
27 if (freeWorkerKey !== -1) {
28 return freeWorkerKey
29 }
30 let minNumberOfTasks = Infinity
31 let lessUsedWorkerKey!: number
32 for (const [index, workerItem] of this.pool.workers.entries()) {
33 const tasksUsage = workerItem.tasksUsage
34 const workerTasks = tasksUsage.run + tasksUsage.running
35 if (workerTasks === 0) {
36 return index
37 } else if (workerTasks < minNumberOfTasks) {
38 minNumberOfTasks = workerTasks
39 lessUsedWorkerKey = index
40 }
41 }
42 return lessUsedWorkerKey
43 }
44
45 /** @inheritDoc */
46 public remove (workerKey: number): boolean {
47 return true
48 }
49 }