X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=bfbc2a84e376ac1db341614f6427943d5405285f;hb=520c8c68ceeccd6b9f4cd363241fdd2c4d628234;hp=3a454f3e6b8d0e1ee1c3a64897206f04c35c3ef8;hpb=56960396878dec81e3ebeea5b76387efca8cc2dc;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index 3a454f3e..bfbc2a84 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -1,42 +1,91 @@ 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, 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] } +/** + * Task error. + * + * @typeParam Data - Type of data sent to the worker. This can only be serializable data. + */ +export interface TaskError { + /** + * Error message. + */ + message: string + /** + * Data passed to the worker triggering the error. + */ + data?: Data +} + +/** + * Task performance. + */ +export interface TaskPerformance { + /** + * Task performance timestamp. + */ + timestamp: number + /** + * Task runtime. + */ + runTime?: number + /** + * Task event loop utilization. + */ + elu?: EventLoopUtilization +} + +/** + * Performance statistics computation. + */ +export interface WorkerStatistics { + runTime: boolean + elu: boolean +} + /** * Message object that is passed between main worker and worker. * + * @typeParam MessageData - Type of data sent to and/or from the worker. This can only be serializable data. * @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< + MessageData = unknown, Data = unknown, - MainWorker extends ClusterWorker | MessagePort | unknown = unknown -> extends Task { + MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort +> extends Task { /** * Kill code. */ readonly kill?: KillBehavior | 1 /** - * Error. + * Task error. */ - readonly error?: string + readonly taskError?: TaskError /** - * Runtime. + * Task performance. */ - readonly runTime?: number + readonly taskPerformance?: TaskPerformance /** * Reference to main worker. - * - * Only for internal use. - * @internal */ readonly parent?: MainWorker + /** + * Whether to compute the given statistics or not. + */ + readonly statistics?: WorkerStatistics } /**