docs: enhance documentation

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

diff --git a/src/pools/thread/fixed.ts b/src/pools/thread/fixed.ts
index da3c0138387495eb63c9f8c1c9c29429088f6cbb..e7d3a727f1e2e7d0804815037c875db5e8963749 100644 (file)
--- a/src/pools/thread/fixed.ts
+++ b/src/pools/thread/fixed.ts
@@ -1,8 +1,13 @@
-import { isMainThread, MessageChannel, SHARE_ENV, Worker } from 'worker_threads'
+import {
+  isMainThread,
+  MessageChannel,
+  SHARE_ENV,
+  Worker
+} from 'node:worker_threads'
 import type { Draft, MessageValue } from '../../utility-types'
 import { AbstractPool } from '../abstract-pool'
 import type { PoolOptions } from '../pool'
-import { PoolType } from '../pool-internal'
+import { PoolType } from '../pool'
 
 /**
  * A thread worker with message channels for communication between main thread and thread worker.
@@ -16,8 +21,8 @@ export type ThreadWorkerWithMessageChannel = Worker & Draft<MessageChannel>
  *
  * This pool selects the threads in a round robin fashion.
  *
- * @template DataType of data sent to the worker. This can only be serializable data.
- * @template ResponseType 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
  */
@@ -28,9 +33,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.
+   * @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,
@@ -40,12 +45,12 @@ export class FixedThreadPool<
     super(numberOfThreads, filePath, opts)
   }
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   protected isMain (): boolean {
     return isMainThread
   }
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   public async destroyWorker (
     worker: ThreadWorkerWithMessageChannel
   ): Promise<void> {
@@ -53,7 +58,7 @@ export class FixedThreadPool<
     await worker.terminate()
   }
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   protected sendToWorker (
     worker: ThreadWorkerWithMessageChannel,
     message: MessageValue<Data>
@@ -61,38 +66,43 @@ export class FixedThreadPool<
     worker.postMessage(message)
   }
 
-  /** @inheritdoc */
-  public registerWorkerMessageListener<Message extends Data | Response> (
+  /** @inheritDoc */
+  protected registerWorkerMessageListener<Message extends Data | Response>(
     messageChannel: ThreadWorkerWithMessageChannel,
     listener: (message: MessageValue<Message>) => void
   ): void {
     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 */
-  public get busy (): boolean {
-    return this.internalGetBusyStatus()
+  /** @inheritDoc */
+  protected get full (): boolean {
+    return this.workerNodes.length === this.numberOfWorkers
+  }
+
+  /** @inheritDoc */
+  protected get busy (): boolean {
+    return this.internalBusy()
   }
 }