Fix documentation generation

[poolifier.git] / src / pools / thread / fixed.ts

diff --git a/src/pools/thread/fixed.ts b/src/pools/thread/fixed.ts
index 7dda3f3090f72459a599128213364cb380a7356b..e8be44f2e3b5b02671f44ce6739df7a87b61273c 100644 (file)
--- 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'
 
 /**
@@ -18,7 +18,6 @@ export type ThreadWorkerWithMessageChannel = Worker & Draft<MessageChannel>
  *
  * @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.
- *
  * @author [Alessandro Pio Ardizio](https://github.com/pioardi)
  * @since 0.0.1
  */
@@ -31,7 +30,7 @@ export class FixedThreadPool<
    *
    * @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 opts Options for this fixed thread pool.
    */
   public constructor (
     numberOfThreads: number,
@@ -41,12 +40,12 @@ export class FixedThreadPool<
     super(numberOfThreads, filePath, opts)
   }
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   protected isMain (): boolean {
     return isMainThread
   }
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   public async destroyWorker (
     worker: ThreadWorkerWithMessageChannel
   ): Promise<void> {
@@ -54,7 +53,7 @@ export class FixedThreadPool<
     await worker.terminate()
   }
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   protected sendToWorker (
     worker: ThreadWorkerWithMessageChannel,
     message: MessageValue<Data>
@@ -62,7 +61,7 @@ export class FixedThreadPool<
     worker.postMessage(message)
   }
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   public registerWorkerMessageListener<Message extends Data | Response> (
     messageChannel: ThreadWorkerWithMessageChannel,
     listener: (message: MessageValue<Message>) => void
@@ -70,29 +69,29 @@ export class FixedThreadPool<
     messageChannel.port2?.on('message', listener)
   }
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   protected createWorker (): ThreadWorkerWithMessageChannel {
     return new Worker(this.filePath, {
       env: SHARE_ENV
     })
   }
 
-  /** @inheritdoc */
+  /** @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()
   }