fix: ensure worker node is defined before emitting
[poolifier.git] / src / pools / worker.ts
index da4cf172d98ee4fcc3384fe4f11bc50800f4a378..7f8148ffcc93db670479a9ce5d7c96b6e576a1d0 100644 (file)
@@ -1,7 +1,7 @@
-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'
+import type { CircularArray } from '../circular-array.js'
+import type { Task } from '../utility-types.js'
 
 /**
  * Callback invoked when the worker has started successfully.
@@ -40,6 +40,17 @@ export type ExitHandler<Worker extends IWorker> = (
   exitCode: number
 ) => void
 
+/**
+ * Worker event handler.
+ *
+ * @typeParam Worker - Type of worker.
+ */
+export type EventHandler<Worker extends IWorker> =
+  | OnlineHandler<Worker>
+  | MessageHandler<Worker>
+  | ErrorHandler<Worker>
+  | ExitHandler<Worker>
+
 /**
  * Measurement statistics.
  *
@@ -154,6 +165,11 @@ export interface WorkerInfo {
    * Ready flag.
    */
   ready: boolean
+  /**
+   * Stealing flag.
+   * This flag is set to `true` when worker node is stealing tasks from another worker node.
+   */
+  stealing: boolean
   /**
    * Task function names.
    */
@@ -206,33 +222,19 @@ export interface IWorker {
    */
   readonly threadId?: number
   /**
-   * Registers an event listener.
+   * Registers an event handler.
    *
    * @param event - The event.
    * @param handler - The event handler.
    */
-  readonly on: (
-    event: string,
-    handler:
-    | OnlineHandler<this>
-    | MessageHandler<this>
-    | ErrorHandler<this>
-    | ExitHandler<this>
-  ) => void
+  readonly on: (event: string, handler: EventHandler<this>) => void
   /**
-   * Registers once an event listener.
+   * Registers once an event handler.
    *
    * @param event - The event.
    * @param handler - The event handler.
    */
-  readonly once: (
-    event: string,
-    handler:
-    | OnlineHandler<this>
-    | MessageHandler<this>
-    | ErrorHandler<this>
-    | ExitHandler<this>
-  ) => void
+  readonly once: (event: string, handler: EventHandler<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.
@@ -256,7 +258,7 @@ export interface IWorker {
 export interface WorkerNodeOptions {
   workerOptions?: WorkerOptions
   env?: Record<string, unknown>
-  tasksQueueBackPressureSize: number
+  tasksQueueBackPressureSize: number | undefined
 }
 
 /**
@@ -348,29 +350,21 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown>
    * Registers a worker event handler.
    *
    * @param event - The event.
-   * @param listener - The event listener.
+   * @param handler - The event handler.
    */
   readonly registerWorkerEventHandler: (
     event: string,
-    listener:
-    | OnlineHandler<Worker>
-    | MessageHandler<Worker>
-    | ErrorHandler<Worker>
-    | ExitHandler<Worker>
+    handler: EventHandler<Worker>
   ) => void
   /**
    * 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:
-    | OnlineHandler<Worker>
-    | MessageHandler<Worker>
-    | ErrorHandler<Worker>
-    | ExitHandler<Worker>
+    handler: EventHandler<Worker>
   ) => void
   /**
    * Gets task function worker usage statistics.