X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=d40754835ab040d7fd8f947238bb9b857c6d58a6;hb=8b58b2c79d34d814340c13824a415595c2476bba;hp=be677a04fa1022a28b9f4de6f80938e5c94ec322;hpb=88af9bf11e70a785747f7511e26d13355ba9deb7;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index be677a04..d4075483 100644 --- a/src/pools/worker.ts +++ b/src/pools/worker.ts @@ -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 = ( exitCode: number ) => void +/** + * Worker event handler. + * + * @typeParam Worker - Type of worker. + */ +export type EventHandler = + | OnlineHandler + | MessageHandler + | ErrorHandler + | ExitHandler + /** * 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. */ @@ -196,7 +212,7 @@ export interface StrategyData { /** * Worker interface. */ -export interface IWorker { +export interface IWorker extends EventEmitter { /** * Cluster worker id. */ @@ -211,28 +227,20 @@ export interface IWorker { * @param event - The event. * @param handler - The event handler. */ - readonly on: ( - event: string, - handler: - | OnlineHandler - | MessageHandler - | ErrorHandler - | ExitHandler - ) => void + readonly on: (event: string, handler: EventHandler) => this /** * Registers once an event handler. * * @param event - The event. * @param handler - The event handler. */ - readonly once: ( - event: string, - handler: - | OnlineHandler - | MessageHandler - | ErrorHandler - | ExitHandler - ) => void + readonly once: (event: string, handler: EventHandler) => this + /** + * Calling `unref()` on a worker allows the thread to exit if this is the only + * active handle in the event system. If the worker is already `unref()`ed calling`unref()` again has no effect. + * @since v10.5.0 + */ + readonly unref?: () => 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 +264,7 @@ export interface IWorker { export interface WorkerNodeOptions { workerOptions?: WorkerOptions env?: Record - tasksQueueBackPressureSize: number + tasksQueueBackPressureSize: number | undefined } /** @@ -352,11 +360,7 @@ export interface IWorkerNode */ readonly registerWorkerEventHandler: ( event: string, - handler: - | OnlineHandler - | MessageHandler - | ErrorHandler - | ExitHandler + handler: EventHandler ) => void /** * Registers once a worker event handler. @@ -366,11 +370,7 @@ export interface IWorkerNode */ readonly registerOnceWorkerEventHandler: ( event: string, - handler: - | OnlineHandler - | MessageHandler - | ErrorHandler - | ExitHandler + handler: EventHandler ) => void /** * Gets task function worker usage statistics. @@ -394,6 +394,6 @@ export interface IWorkerNode * @internal */ export interface WorkerNodeEventDetail { - workerId: number + workerId?: number workerNodeKey?: number }