Generate documentation

[poolifier.git] / src / pools / abstract-pool.ts

diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts
index 928b24c65832a38ef625b7b07d498ce9f3ad504b..10fe128170b5363b0b04d58b82e451369a0f9d3d 100644 (file)
--- a/src/pools/abstract-pool.ts
+++ b/src/pools/abstract-pool.ts
@@ -26,16 +26,16 @@ export abstract class AbstractPool<
   Data = unknown,
   Response = unknown
 > implements IPoolInternal<Worker, Data, Response> {
-  /** @inheritdoc */
+  /** @inheritDoc */
   public readonly workers: Worker[] = []
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   public readonly tasks: Map<Worker, number> = new Map<Worker, number>()
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   public readonly emitter?: PoolEmitter
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   public readonly max?: number
 
   /**
@@ -143,25 +143,25 @@ export abstract class AbstractPool<
     this.opts.enableEvents = opts.enableEvents ?? true
   }
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   public abstract get type (): PoolType
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   public get numberOfRunningTasks (): number {
     return this.promiseMap.size
   }
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   public getWorkerRunningTasks (worker: Worker): number | undefined {
     return this.tasks.get(worker)
   }
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   public getWorkerIndex (worker: Worker): number {
     return this.workers.indexOf(worker)
   }
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   public setWorkerChoiceStrategy (
     workerChoiceStrategy: WorkerChoiceStrategy
   ): void {
@@ -171,7 +171,7 @@ export abstract class AbstractPool<
     )
   }
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   public abstract get busy (): boolean
 
   protected internalGetBusyStatus (): boolean {
@@ -181,7 +181,7 @@ export abstract class AbstractPool<
     )
   }
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   public findFreeWorker (): Worker | false {
     for (const worker of this.workers) {
       if (this.getWorkerRunningTasks(worker) === 0) {
@@ -192,7 +192,7 @@ export abstract class AbstractPool<
     return false
   }
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   public execute (data: Data): Promise<Response> {
     // Configure worker to handle message with the specified task
     const worker = this.chooseWorker()
@@ -204,7 +204,7 @@ export abstract class AbstractPool<
     return res
   }
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   public async destroy (): Promise<void> {
     await Promise.all(this.workers.map(worker => this.destroyWorker(worker)))
   }