fix: refine possible null exception fix at task response handling

[poolifier.git] / src / pools / worker.ts

diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index 1a94ef60950dffe84e9430374dcd13395a956bab..9a27d8a5056bb7b4b222f2d210803699ab95ad0d 100644 (file)
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -1,4 +1,4 @@
-import type { MessageChannel } from 'node:worker_threads'
+import type { MessageChannel, WorkerOptions } from 'node:worker_threads'
 import type { EventEmitter } from 'node:events'
 import type { CircularArray } from '../circular-array'
 import type { Task } from '../utility-types'
@@ -198,12 +198,15 @@ export interface StrategyData {
  */
 export interface IWorker {
   /**
-   * Worker id.
+   * Cluster worker id.
    */
   readonly id?: number
+  /**
+   * Worker thread worker id.
+   */
   readonly threadId?: number
   /**
-   * Registers an event listener.
+   * Registers an event handler.
    *
    * @param event - The event.
    * @param handler - The event handler.
@@ -217,7 +220,7 @@ export interface IWorker {
     | ExitHandler<this>
   ) => void
   /**
-   * Registers once an event listener.
+   * Registers once an event handler.
    *
    * @param event - The event.
    * @param handler - The event handler.
@@ -230,6 +233,19 @@ export interface IWorker {
     | ErrorHandler<this>
     | ExitHandler<this>
   ) => void
+  /**
+   * Stop all JavaScript execution in the worker thread as soon as possible.
+   * Returns a Promise for the exit code that is fulfilled when the `'exit' event` is emitted.
+   */
+  readonly terminate?: () => Promise<number>
+  /**
+   * Cluster worker disconnect.
+   */
+  readonly disconnect?: () => void
+  /**
+   * Cluster worker kill.
+   */
+  readonly kill?: (signal?: string) => void
 }
 
 /**
@@ -270,7 +286,7 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown>
    */
   strategyData?: StrategyData
   /**
-   * Message channel (worker_threads only).
+   * Message channel (worker thread only).
    */
   readonly messageChannel?: MessageChannel
   /**
@@ -325,18 +341,18 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown>
    */
   readonly resetUsage: () => void
   /**
-   * Closes communication channel.
+   * Terminates the worker node.
    */
-  readonly closeChannel: () => void
+  readonly terminate: () => Promise<void>
   /**
    * Registers a worker event handler.
    *
    * @param event - The event.
-   * @param listener - The event listener.
+   * @param handler - The event handler.
    */
   readonly registerWorkerEventHandler: (
     event: string,
-    listener:
+    handler:
     | OnlineHandler<Worker>
     | MessageHandler<Worker>
     | ErrorHandler<Worker>
@@ -346,11 +362,11 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown>
    * Registers once a worker event handler.
    *
    * @param event - The event.
-   * @param listener - The event listener.
+   * @param handler - The event handler.
    */
   readonly registerOnceWorkerEventHandler: (
     event: string,
-    listener:
+    handler:
     | OnlineHandler<Worker>
     | MessageHandler<Worker>
     | ErrorHandler<Worker>