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 a37ccbf76b5864b8cc4f27b847596d7b9c533d38..e7d3a727f1e2e7d0804815037c875db5e8963749 100644 (file)
--- a/src/pools/thread/fixed.ts
+++ b/src/pools/thread/fixed.ts
@@ -7,7 +7,7 @@ import {
 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.
@@ -45,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> {
@@ -58,7 +58,7 @@ export class FixedThreadPool<
     await worker.terminate()
   }
 
-  /** {@inheritDoc} */
+  /** @inheritDoc */
   protected sendToWorker (
     worker: ThreadWorkerWithMessageChannel,
     message: MessageValue<Data>
@@ -66,22 +66,22 @@ 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])
@@ -91,13 +91,18 @@ export class FixedThreadPool<
     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()
   }
 }