docs: refine some comments

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

diff --git a/src/pools/thread/fixed.ts b/src/pools/thread/fixed.ts
index 11a24e2780dc445a37cdca15808eb71f95dd5bd9..69b3c3071e487abf1658c454289c7117ee351152 100644 (file)
--- a/src/pools/thread/fixed.ts
+++ b/src/pools/thread/fixed.ts
@@ -1,10 +1,9 @@
 import {
-  type MessageChannel,
-  type MessagePort,
+  isMainThread,
   type TransferListItem,
   type Worker,
-  isMainThread
 } from 'node:worker_threads'
+
 import type { MessageValue } from '../../utility-types.js'
 import { AbstractPool } from '../abstract-pool.js'
 import { type PoolOptions, type PoolType, PoolTypes } from '../pool.js'
@@ -17,7 +16,6 @@ export type ThreadPoolOptions = PoolOptions<Worker>
 
 /**
  * A thread pool with a fixed number of threads.
- *
  * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
  * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
  * @author [Alessandro Pio Ardizio](https://github.com/pioardi)
@@ -29,10 +27,10 @@ export class FixedThreadPool<
 > extends AbstractPool<Worker, Data, Response> {
   /**
    * 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 maximumNumberOfThreads - The maximum number of threads for this pool.
    */
   public constructor (
     numberOfThreads: number,
@@ -52,10 +50,13 @@ export class FixedThreadPool<
   protected sendToWorker (
     workerNodeKey: number,
     message: MessageValue<Data>,
-    transferList?: TransferListItem[]
+    transferList?: readonly TransferListItem[]
   ): void {
-    this.workerNodes[workerNodeKey].messageChannel?.port1?.postMessage(
-      { ...message, workerId: this.getWorkerInfo(workerNodeKey).id },
+    this.workerNodes[workerNodeKey]?.messageChannel?.port1.postMessage(
+      {
+        ...message,
+        workerId: this.getWorkerInfo(workerNodeKey)?.id,
+      } satisfies MessageValue<Data>,
       transferList
     )
   }
@@ -63,14 +64,14 @@ export class FixedThreadPool<
   /** @inheritDoc */
   protected sendStartupMessageToWorker (workerNodeKey: number): void {
     const workerNode = this.workerNodes[workerNodeKey]
-    const port2: MessagePort = (workerNode.messageChannel as MessageChannel)
-      .port2
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const port2 = workerNode.messageChannel!.port2
     workerNode.worker.postMessage(
       {
         ready: false,
-        workerId: this.getWorkerInfo(workerNodeKey).id,
-        port: port2
-      },
+        workerId: this.getWorkerInfo(workerNodeKey)?.id,
+        port: port2,
+      } satisfies MessageValue<Data>,
       [port2]
     )
   }
@@ -80,7 +81,7 @@ export class FixedThreadPool<
     workerNodeKey: number,
     listener: (message: MessageValue<Message>) => void
   ): void {
-    this.workerNodes[workerNodeKey].messageChannel?.port1?.on(
+    this.workerNodes[workerNodeKey].messageChannel?.port1.on(
       'message',
       listener
     )
@@ -91,7 +92,7 @@ export class FixedThreadPool<
     workerNodeKey: number,
     listener: (message: MessageValue<Message>) => void
   ): void {
-    this.workerNodes[workerNodeKey].messageChannel?.port1?.once(
+    this.workerNodes[workerNodeKey].messageChannel?.port1.once(
       'message',
       listener
     )
@@ -102,7 +103,7 @@ export class FixedThreadPool<
     workerNodeKey: number,
     listener: (message: MessageValue<Message>) => void
   ): void {
-    this.workerNodes[workerNodeKey].messageChannel?.port1?.off(
+    this.workerNodes[workerNodeKey].messageChannel?.port1.off(
       'message',
       listener
     )