X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fthread%2Ffixed.ts;h=13a280b54723e2fcf18f2af5ce73322d4e4f8a11;hb=b4e757784e2b9ffe2c22b65b21e8bf665abd9f56;hp=abd1b6b8b081ac2740ac96ea6a1265a690ff407b;hpb=7c0ba92006a5c188738ffc5ff642c51f172df3d6;p=poolifier.git

diff --git a/src/pools/thread/fixed.ts b/src/pools/thread/fixed.ts
index abd1b6b8..13a280b5 100644
--- a/src/pools/thread/fixed.ts
+++ b/src/pools/thread/fixed.ts
@@ -1,7 +1,7 @@
 import { isMainThread, MessageChannel, SHARE_ENV, Worker } from 'worker_threads'
 import type { Draft, MessageValue } from '../../utility-types'
-import type { PoolOptions } from '../abstract-pool'
 import { AbstractPool } from '../abstract-pool'
+import type { PoolOptions } from '../pool'
 import { PoolType } from '../pool-internal'
 
 /**
@@ -16,9 +16,8 @@ export type ThreadWorkerWithMessageChannel = Worker & Draft<MessageChannel>
  *
  * This pool selects the threads in a round robin fashion.
  *
- * @template Data Type of data sent to the worker. This can only be serializable data.
- * @template Response Type of response of execution. This can only be serializable data.
- *
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Response - Type of response of execution. This can only be serializable data.
  * @author [Alessandro Pio Ardizio](https://github.com/pioardi)
  * @since 0.0.1
  */
@@ -29,9 +28,9 @@ export class FixedThreadPool<
   /**
    * Constructs a new poolifier fixed thread pool.
    *
-   * @param numberOfThreads Number of threads for this pool.
-   * @param filePath Path to an implementation of a `ThreadWorker` file, which can be relative or absolute.
-   * @param opts Options for this fixed thread pool. Default: `{}`
+   * @param numberOfThreads - Number of threads for this pool.
+   * @param filePath - Path to an implementation of a `ThreadWorker` file, which can be relative or absolute.
+   * @param opts - Options for this fixed thread pool.
    */
   public constructor (
     numberOfThreads: number,
@@ -41,11 +40,12 @@ export class FixedThreadPool<
     super(numberOfThreads, filePath, opts)
   }
 
+  /** {@inheritDoc} */
   protected isMain (): boolean {
     return isMainThread
   }
 
-  /** @inheritdoc */
+  /** {@inheritDoc} */
   public async destroyWorker (
     worker: ThreadWorkerWithMessageChannel
   ): Promise<void> {
@@ -53,6 +53,7 @@ export class FixedThreadPool<
     await worker.terminate()
   }
 
+  /** {@inheritDoc} */
   protected sendToWorker (
     worker: ThreadWorkerWithMessageChannel,
     message: MessageValue<Data>
@@ -60,35 +61,37 @@ export class FixedThreadPool<
     worker.postMessage(message)
   }
 
-  /** @inheritdoc */
-  public registerWorkerMessageListener<Message extends Data | Response> (
+  /** {@inheritDoc} */
+  public registerWorkerMessageListener<Message extends Data | Response>(
     messageChannel: ThreadWorkerWithMessageChannel,
     listener: (message: MessageValue<Message>) => void
   ): void {
     messageChannel.port2?.on('message', listener)
   }
 
+  /** {@inheritDoc} */
   protected createWorker (): ThreadWorkerWithMessageChannel {
     return new Worker(this.filePath, {
       env: SHARE_ENV
     })
   }
 
+  /** {@inheritDoc} */
   protected afterWorkerSetup (worker: ThreadWorkerWithMessageChannel): void {
     const { port1, port2 } = new MessageChannel()
     worker.postMessage({ parent: port1 }, [port1])
     worker.port1 = port1
     worker.port2 = port2
-    // Listen worker messages.
+    // Listen to worker messages.
     this.registerWorkerMessageListener(worker, super.workerListener())
   }
 
-  /** @inheritdoc */
+  /** {@inheritDoc} */
   public get type (): PoolType {
     return PoolType.FIXED
   }
 
-  /** @inheritdoc */
+  /** {@inheritDoc} */
   public get busy (): boolean {
     return this.internalGetBusyStatus()
   }