-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'
*/
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.
| ExitHandler<this>
) => void
/**
- * Registers once an event listener.
+ * Registers once an event handler.
*
* @param event - The event.
* @param handler - The event handler.
| 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
}
/**
*/
strategyData?: StrategyData
/**
- * Message channel (worker_threads only).
+ * Message channel (worker thread only).
*/
readonly messageChannel?: MessageChannel
/**
*/
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>
* 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>