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.
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.
*
* 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.
*/
* @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 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.
export interface WorkerNodeOptions {
workerOptions?: WorkerOptions
env?: Record<string, unknown>
- tasksQueueBackPressureSize: number
+ tasksQueueBackPressureSize: number | undefined
}
/**
*/
readonly registerWorkerEventHandler: (
event: string,
- handler:
- | OnlineHandler<Worker>
- | MessageHandler<Worker>
- | ErrorHandler<Worker>
- | ExitHandler<Worker>
+ handler: EventHandler<Worker>
) => void
/**
* Registers once a worker event handler.
*/
readonly registerOnceWorkerEventHandler: (
event: string,
- handler:
- | OnlineHandler<Worker>
- | MessageHandler<Worker>
- | ErrorHandler<Worker>
- | ExitHandler<Worker>
+ handler: EventHandler<Worker>
) => void
/**
* Gets task function worker usage statistics.