chore: generate documentation

[poolifier.git] / src / worker / thread-worker.ts

diff --git a/src/worker/thread-worker.ts b/src/worker/thread-worker.ts
index f1e38076698622d1d4f010e821453842d16113a3..75cd9da505b709a954f188ab209145221c90bc84 100644 (file)
--- a/src/worker/thread-worker.ts
+++ b/src/worker/thread-worker.ts
@@ -1,6 +1,10 @@
-import type { MessagePort } from 'worker_threads'
-import { isMainThread, parentPort } from 'worker_threads'
-import type { MessageValue } from '../utility-types'
+import type { MessagePort } from 'node:worker_threads'
+import { isMainThread, parentPort } from 'node:worker_threads'
+import type {
+  MessageValue,
+  TaskFunctions,
+  WorkerFunction
+} from '../utility-types'
 import { AbstractWorker } from './abstract-worker'
 import type { WorkerOptions } from './worker-options'
 
@@ -13,9 +17,8 @@ import type { WorkerOptions } from './worker-options'
  * If you use a `DynamicThreadPool` the extra workers that were created will be terminated,
  * but the minimum number of workers will be guaranteed.
  *
- * @template Data Type of data this worker receives from pool's execution. This can only be serializable data.
- * @template Response Type of response the worker sends back to the main thread. This can only be serializable data.
- *
+ * @typeParam Data - Type of data this worker receives from pool's execution. This can only be serializable data.
+ * @typeParam Response - Type of response the worker sends back to the main thread. This can only be serializable data.
  * @author [Alessandro Pio Ardizio](https://github.com/pioardi)
  * @since 0.0.1
  */
@@ -26,14 +29,25 @@ export class ThreadWorker<
   /**
    * Constructs a new poolifier thread worker.
    *
-   * @param fn Function processed by the worker when the pool's `execution` function is invoked.
-   * @param opts Options for the worker.
+   * @param taskFunctions - Task function(s) processed by the worker when the pool's `execution` function is invoked.
+   * @param opts - Options for the worker.
    */
-  public constructor (fn: (data: Data) => Response, opts: WorkerOptions = {}) {
-    super('worker-thread-pool:poolifier', isMainThread, fn, parentPort, opts)
+  public constructor (
+    taskFunctions:
+    | WorkerFunction<Data, Response>
+    | TaskFunctions<Data, Response>,
+    opts: WorkerOptions = {}
+  ) {
+    super(
+      'worker-thread-pool:poolifier',
+      isMainThread,
+      taskFunctions,
+      parentPort,
+      opts
+    )
   }
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   protected sendToMainWorker (message: MessageValue<Response>): void {
     this.getMainWorker().postMessage(message)
   }