X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=9cdf6b0a7e82f9d1e3da5fb434537ca8e2d943f9;hb=058a94577c79d9b62bf54516ea27e0e70f934fcc;hp=b5611f9ea18c2a90403998245173693525f45b2c;hpb=a34454964733f585af19a04f21f9e35eb18c77b1;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index b5611f9e..9cdf6b0a 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -1,46 +1,68 @@ import type { Worker as ClusterWorker } from 'node:cluster' import type { MessagePort } from 'node:worker_threads' +import type { EventLoopUtilization } from 'node:perf_hooks' import type { KillBehavior } from './worker/worker-options' -import type { IWorker } from './pools/worker' +import type { IWorker, Task } from './pools/worker' /** * Make all properties in T non-readonly. + * + * @typeParam T - Type in which properties will be non-readonly. */ export type Draft = { -readonly [P in keyof T]?: T[P] } /** - * Message object that is passed between worker and main worker. + * Performance statistics computation. + */ +export interface WorkerStatistics { + runTime: boolean + waitTime: boolean + elu: boolean +} + +/** + * Message object that is passed between main worker and worker. + * + * @typeParam Data - Type of data sent to the worker. This can only be serializable data. + * @typeParam MainWorker - Type of main worker. + * @internal */ export interface MessageValue< Data = unknown, - MainWorker extends ClusterWorker | MessagePort | unknown = unknown -> { - /** - * Input data that will be passed to the worker. - */ - readonly data?: Data - /** - * Id of the message. - */ - readonly id?: string + MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort +> extends Task { /** * Kill code. */ readonly kill?: KillBehavior | 1 /** - * Error. + * Task error. */ readonly error?: string + /** + * Task data triggering task error. + */ + readonly errorData?: unknown /** * Runtime. */ readonly runTime?: number + /** + * Wait time. + */ + readonly waitTime?: number + /** + * Event loop utilization. + */ + readonly elu?: EventLoopUtilization /** * Reference to main worker. - * - * Only for internal use. */ readonly parent?: MainWorker + /** + * Whether to compute the given statistics or not. + */ + readonly statistics?: WorkerStatistics } /** @@ -48,6 +70,7 @@ export interface MessageValue< * * @typeParam Worker - Type of worker. * @typeParam Response - Type of execution response. This can only be serializable data. + * @internal */ export interface PromiseResponseWrapper< Worker extends IWorker,